Method: FileboundClient::Endpoints::Routes#route_document_to_workflow

Defined in:
lib/filebound_client/endpoints/routes.rb

#route_document_to_workflow(route_id, document_id, notes) ⇒ RoutedItem

Routes a document to the start of a workflow

Parameters:

  • route_id (long) —

    the route key

  • document_id (int) —

    the document key to route

  • notes (string) —

    optional notes to from the user who started the document down the route

Returns:

  • (RoutedItem) —

    a hash of the RoutedItem resource that was added



25
26
27
28
29
 
# File 'lib/filebound_client/endpoints/routes.rb', line 25

def route_document_to_workflow(route_id, document_id, notes)
  params = { documentId: document_id }
  params[:notes] = notes if notes
  put("/routes/#{route_id}", params, nil)
end