Flows

Flows

The /flow API provides access to details on flows.

/flow/:flow_id

http://localhost/jarvis-agent/n2int-angular/api/flow/

• GET Provides access to all flows the user is able to see, based on folder and flow permission restrictions. The user must also have either the view.design.view or view.organise.view role. Optionally the flow_id can be provided to restrict the results to a singular flow. A flow is included in the results if:
  • The folder the flow is stored in is executable by the user. This means the user has execute access due to user, group or world permissions on the folder itself. In addition one of the following flow permissions is required:
  • The flow has world read access.
  • The flow has group read access, and the user belongs to the group that owns the flow.
  • The flow has user read access, and the flow is owned by the authenticated user.
• GET without a flow_id will return a list of all flows in a specific folder. Provide folder_id as a parameter to the query.
• PUT Allows existing flows to be updated, subject to role restrictions. The user must have view.design.edit role access, and the folder must match one of the following permissions:
  • The folder the flow is stored in is executable by the user. This means the user has execute access due to user, group or world permissions on the folder itself. In addition one of the following flow permissions is required:
  • The flow has world write access.
  • The flow has group write access, and the user belongs to the group that owns the flow.
  • The flow has user write access, and the flow is owned by the authenticated user.
• DELETE Allows the flow to be marked as deleted, subject to the same role restrictions as for PUT. Note that deleting a flow only marks the flow as deleted. The flow and its execution history continue to exist in the database.

Note that flow creation is not currently published as part of this API.

/flow/:flow_id/version/:flow_version_id

http://localhost/jarvis-agent/n2int-angular/api/flow/:flow_id/version/:flow_version_id

• GET Provides access to a specific flow version for the flow identified. A ccess restrictions are equivalent to GET restrictions for /flow/:flow_id. Parameters:
  • flow_id The flow ID of the flow with the given version ID. Required.
  • flow_version_id The flow version ID to retrieve. Required.

/flow/:flow_id/history

http://localhost/jarvis-agent/n2int-angular/api/flow/:flow_id/history

• GET Provides access to the execution and version history of the flow with ID given by flow_id. Access restrictions are equivalent to GET restrictions for /flow/:flow_id.

/flow/search

http://localhost/jarvis-agent/n2int-angular/api/flow/search

• GET Search for flows whose name matches a provided substring. Parameters:
  • query Substring to search for in flow names. The search is performed in a case insensitive manner. This parameter is optional.
  • folder_id The folder ID for the folder of flows to list. This parameter is optional.

Either query or folder_id must be provided in the request. Results returned are restricted in the same fashion as results from the GET request /flow/:flow_id.