All URIs are relative to https://CHANGEME.api.processmaker.io/api/v1
| Method | HTTP request | Description |
|---|---|---|
| AddEvent | Post /processes/{process_id}/events | |
| AddEventConnector | Post /processes/{process_id}/events/{event_id}/connectors | |
| AddFlow | Post /processes/{process_id}/flows | |
| AddGateway | Post /processes/{process_id}/gateways | |
| AddGroup | Post /groups | |
| AddGroupsToTask | Put /processes/{process_id}/tasks/{task_id}/groups | |
| AddInputOutput | Post /processes/{process_id}/tasks/{task_id}/inputoutput | |
| AddInstance | Post /processes/{process_id}/instances | |
| AddOauthClient | Post /users/{user_id}/clients | |
| AddProcess | Post /processes | |
| AddTask | Post /processes/{process_id}/tasks | |
| AddTaskConnector | Post /processes/{process_id}/tasks/{task_id}/connectors | |
| AddUser | Post /users | |
| AddUsersToGroup | Put /groups/{id}/users | |
| DeleteEvent | Delete /processes/{process_id}/events/{event_id} | |
| DeleteEventConnector | Delete /processes/{process_id}/events/{event_id}/connectors/{connector_id} | |
| DeleteFlow | Delete /processes/{process_id}/flows/{flow_id} | |
| DeleteGateway | Delete /processes/{process_id}/gateways/{gateway_id} | |
| DeleteGroup | Delete /groups/{id} | |
| DeleteInputOutput | Delete /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid} | |
| DeleteInstance | Delete /processes/{process_id}/instances/{instance_id} | |
| DeleteOauthClient | Delete /users/{user_id}/clients/{client_id} | |
| DeleteProcess | Delete /processes/{id} | |
| DeleteTask | Delete /processes/{process_id}/tasks/{task_id} | |
| DeleteTaskConnector | Delete /processes/{process_id}/tasks/{task_id}/connectors/{connector_id} | |
| DeleteUser | Delete /users/{id} | |
| EventTrigger | Post /processes/{process_id}/events/{event_id}/trigger | |
| EventWebhook | Post /processes/{process_id}/events/{event_id}/webhook | |
| FindByFieldInsideDataModel | Get /processes/{process_id}/datamodels/search/{search_param} | |
| FindDataModel | Get /processes/{process_id}/instances/{instance_id}/datamodel | |
| FindEventById | Get /processes/{process_id}/events/{event_id} | |
| FindEventConnectorById | Get /processes/{process_id}/events/{event_id}/connectors/{connector_id} | |
| FindEventConnectors | Get /processes/{process_id}/events/{event_id}/connectors | |
| FindEvents | Get /processes/{process_id}/events | |
| FindFlowById | Get /processes/{process_id}/flows/{flow_id} | |
| FindFlows | Get /processes/{process_id}/flows | |
| FindGatewayById | Get /processes/{process_id}/gateways/{gateway_id} | |
| FindGateways | Get /processes/{process_id}/gateways | |
| FindGroupById | Get /groups/{id} | |
| FindGroups | Get /groups | |
| FindInputOutputById | Get /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid} | |
| FindInputOutputs | Get /processes/{process_id}/tasks/{task_id}/inputoutput | |
| FindInstanceById | Get /processes/{process_id}/instances/{instance_id} | |
| FindInstances | Get /processes/{process_id}/instances | |
| FindOauthClientById | Get /users/{user_id}/clients/{client_id} | |
| FindOauthClients | Get /users/{user_id}/clients | |
| FindProcessById | Get /processes/{id} | |
| FindProcesses | Get /processes | |
| FindTaskById | Get /processes/{process_id}/tasks/{task_id} | |
| FindTaskConnectorById | Get /processes/{process_id}/tasks/{task_id}/connectors/{connector_id} | |
| FindTaskConnectors | Get /processes/{process_id}/tasks/{task_id}/connectors | |
| FindTaskInstanceById | Get /task_instances/{task_instance_id} | |
| FindTaskInstances | Get /task_instances | |
| FindTaskInstancesByInstanceAndTaskId | Get /instances/{instance_id}/tasks/{task_id}/task_instances | |
| FindTaskInstancesByInstanceAndTaskIdDelegated | Get /instances/{instance_id}/tasks/{task_id}/task_instances/delegated | |
| FindTaskInstancesByInstanceAndTaskIdStarted | Get /instances/{instance_id}/tasks/{task_id}/task_instances/started | |
| FindTasks | Get /processes/{process_id}/tasks | |
| FindTokens | Get /processes/{process_id}/instances/{instance_id}/tokens | |
| FindUserById | Get /users/{id} | |
| FindUsers | Get /users | |
| ImportBpmnFile | Post /processes/import | |
| MyselfUser | Get /users/myself | |
| RemoveGroupsFromTask | Delete /processes/{process_id}/tasks/{task_id}/groups | |
| RemoveUsersFromGroup | Delete /groups/{id}/users | |
| SyncGroupsToTask | Post /processes/{process_id}/tasks/{task_id}/groups | |
| SyncUsersToGroup | Post /groups/{id}/users | |
| UpdateEvent | Put /processes/{process_id}/events/{event_id} | |
| UpdateEventConnector | Put /processes/{process_id}/events/{event_id}/connectors/{connector_id} | |
| UpdateFlow | Put /processes/{process_id}/flows/{flow_id} | |
| UpdateGateway | Put /processes/{process_id}/gateways/{gateway_id} | |
| UpdateGroup | Put /groups/{id} | |
| UpdateInputOutput | Put /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid} | |
| UpdateInstance | Put /processes/{process_id}/instances/{instance_id} | |
| UpdateOauthClient | Put /users/{user_id}/clients/{client_id} | |
| UpdateProcess | Put /processes/{id} | |
| UpdateTask | Put /processes/{process_id}/tasks/{task_id} | |
| UpdateTaskConnector | Put /processes/{process_id}/tasks/{task_id}/connectors/{connector_id} | |
| UpdateTaskInstance | Patch /task_instances/{task_instance_id} | |
| UpdateUser | Put /users/{id} |
EventItem AddEvent($processId, $eventCreateItem)
This method creates the new event.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the event | |
| eventCreateItem | EventCreateItem | JSON API response with the event object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventConnector1 AddEventConnector($processId, $eventId, $eventConnectorCreateItem)
This method is intended for creating a new event connector.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| eventId | string | ID of the event to fetch | |
| eventConnectorCreateItem | EventConnectorCreateItem | JSON API with the EventConnector object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FlowItem AddFlow($processId, $flowCreateItem)
This method creates a new Sequence Flow.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the flow | |
| flowCreateItem | FlowCreateItem | JSON API response with the Flow object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayItem AddGateway($processId, $gatewayCreateItem)
This method creates a new gateway.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the gateway | |
| gatewayCreateItem | GatewayCreateItem | JSON API response with the gateway object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GroupItem AddGroup($groupCreateItem)
This method creates a new group.
| Name | Type | Description | Notes |
|---|---|---|---|
| groupCreateItem | GroupCreateItem | JSON API with the Group object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess AddGroupsToTask($processId, $taskId, $taskAddGroupsItem)
This method assigns group(s) to the chosen task
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| taskId | string | ID of the task to be modified | |
| taskAddGroupsItem | TaskAddGroupsItem | JSON API with Group IDs to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InputOutputItem AddInputOutput($processId, $taskId, $inputOutputCreateItem)
This method creates a new Input/Output object.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to Input/Output object | |
| taskId | string | Task instance ID related to Input/Output object | |
| inputOutputCreateItem | InputOutputCreateItem | Create and add a new Input/Output object with JSON API |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InstanceItem AddInstance($processId, $instanceCreateItem)
This method creates a new instance.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the instance | |
| instanceCreateItem | InstanceCreateItem | JSON API response with the instance object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OauthClientItem AddOauthClient($userId, $oauthClientCreateItem)
This method creates a new Oauth client for the user.
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | ID of the user related to the Oauth client | |
| oauthClientCreateItem | OauthClientCreateItem | JSON API with the Oauth Client object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProcessItem AddProcess($processCreateItem)
This method creates a new process.
| Name | Type | Description | Notes |
|---|---|---|---|
| processCreateItem | ProcessCreateItem | JSON API response with the process object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskItem AddTask($processId, $taskCreateItem)
This method creates a new task.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the task | |
| taskCreateItem | TaskCreateItem | JSON API with the task object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskConnector1 AddTaskConnector($processId, $taskId, $taskConnectorCreateItem)
This method is for creating a new task connector
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| taskId | string | ID of the task to fetch | |
| taskConnectorCreateItem | TaskConnectorCreateItem | JSON API with the TaskConnector object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserItem AddUser($userCreateItem)
This method creates a new user in the system. The client_id will appear in the results. The client_id is required to obtain a client_secret and then you will be able to use it in an Oauth authorization key. Refer to Oauth Client APIs
| Name | Type | Description | Notes |
|---|---|---|---|
| userCreateItem | UserCreateItem | JSON API with the User object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess AddUsersToGroup($id, $groupAddUsersItem)
This method adds one or more new users to a group.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of group to be modified | |
| groupAddUsersItem | GroupAddUsersItem | JSON API response with array of user IDs |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteEvent($processId, $eventId)
This method deletes an event using the event ID and process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| eventId | string | ID of the event to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteEventConnector($processId, $eventId, $connectorId)
This method is for deleting a single event connector based on event ID, process ID and Connector ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process item | |
| eventId | string | ID of item to fetch | |
| connectorId | string | ID of EventConnector to fetch |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteFlow($processId, $flowId)
This method deletes the Sequence Flow using the flow ID and the process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| flowId | string | ID of the flow to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteGateway($processId, $gatewayId)
This method deletes a single item using the gateway ID and the process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| gatewayId | string | ID of the process to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteGroup($id)
This method deletes a group using the group ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of group to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteInputOutput($processId, $taskId, $inputoutputUid)
This method deletes the Input/Output based on the Input/Output ID, process ID and task ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the Input/Output object | |
| taskId | string | Task instance ID related to Input/Output object | |
| inputoutputUid | string | Input/Output ID to fetch |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteInstance($processId, $instanceId)
This method deletes an instance using the instance ID and the process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| instanceId | string | ID of the instance to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteOauthClient($userId, $clientId)
This method deletes an Oauth client using the Oauth client and user IDs.
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | User ID | |
| clientId | string | ID of Oauth client to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteProcess($id)
This method deletes a process using the process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Process ID to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteTask($processId, $taskId)
This method deletes a task using the task ID and the process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| taskId | string | ID of a task to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteTaskConnector($processId, $taskId, $connectorId)
This method is for deleting a single task connector based on task ID, the process ID and the Connector ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process item to fetch | |
| taskId | string | ID of the task item to fetch | |
| connectorId | string | ID of TaskConnector to fetch |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteUser($id)
This method deletes a user from the system.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of user to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataModelItem1 EventTrigger($processId, $eventId, $triggerEventCreateItem)
This method starts/triggers an event.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the event | |
| eventId | string | ID of the event to trigger | |
| triggerEventCreateItem | TriggerEventCreateItem | Json with some parameters |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string EventWebhook($processId, $eventId, $triggerBody)
This webhook method triggers a given event object.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the event | |
| eventId | string | ID of the event to trigger | |
| triggerBody | string | Freeform JSON structure, it will be passed to the newly created DataModel |
string
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataModelCollection FindByFieldInsideDataModel($processId, $searchParam, $page, $perPage)
This method returns the data model by field passed in get argument.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| searchParam | string | Key and value of searched field in DataModel | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataModelItem1 FindDataModel($processId, $instanceId, $page, $perPage)
This method returns the instance data model and lets the user work with it directly.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| instanceId | string | ID of the instance to return | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventItem FindEventById($processId, $eventId)
This method retrieves an event using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| eventId | string | ID of the event to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventConnector1 FindEventConnectorById($processId, $eventId, $connectorId)
This method returns all event connectors related to the run process and event.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| eventId | string | ID of Event to fetch | |
| connectorId | string | ID of EventConnector to fetch |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventConnectorsCollection FindEventConnectors($processId, $eventId, $page, $perPage)
This method returns all event connectors related to the run process and Event.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| eventId | string | ID of the task to fetch | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventCollection FindEvents($processId, $page, $perPage)
This method returns all events related to the running process.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the event | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FlowItem FindFlowById($processId, $flowId)
This method retrieves a flow based on its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| flowId | string | ID of the flow to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FlowCollection FindFlows($processId, $page, $perPage)
This method retrieves all existing flows.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the flow | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayItem FindGatewayById($processId, $gatewayId)
This method retrieves a gateway based on its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| gatewayId | string | ID of gateway to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayCollection FindGateways($processId, $page, $perPage)
This method retrieves all existing gateways.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the gateway | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GroupItem FindGroupById($id)
This method retrieves a group using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of group to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GroupCollection FindGroups($page, $perPage)
This method retrieves all existing groups.
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InputOutputItem FindInputOutputById($processId, $taskId, $inputoutputUid)
This method retrieves an Input/Output object using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the Input/Output object | |
| taskId | string | Task instance ID related to the Input/Output object | |
| inputoutputUid | string | ID of Input/Output to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InputOutputCollection FindInputOutputs($processId, $taskId, $page, $perPage)
This method retrieves all existing Input/Output objects in the related task instance.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to Input/Output object | |
| taskId | string | Task instance ID related to Input/Output object | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InstanceItem FindInstanceById($processId, $instanceId)
This method retrieves an instance using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| instanceId | string | ID of the instance to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InstanceCollection FindInstances($processId, $page, $perPage)
This method retrieves instances related to the process using the process ID
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the instances | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OauthClientItem FindOauthClientById($userId, $clientId)
This method retrieves an Oauth client for the User based on its ID. The response contains the client_secret required to obtain the access_token.
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | ID of user to retrieve | |
| clientId | string | ID of Oauth client to retrieve |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OauthClientCollection FindOauthClients($userId, $page, $perPage)
This method retrieves all existing Oauth clients belonging to a user.
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | User ID related to the Oauth clients | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProcessItem FindProcessById($id)
This method retrieves a process using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the process to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProcessCollection FindProcesses($page, $perPage)
This method retrieves all existing processes.
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskItem FindTaskById($processId, $taskId)
This method retrieves a task using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| taskId | string | ID of the task to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskConnector1 FindTaskConnectorById($processId, $taskId, $connectorId)
This method is for retrieving a task connector based on its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| taskId | string | ID of the task to fetch | |
| connectorId | string | ID of TaskConnector to fetch |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskConnectorsCollection FindTaskConnectors($processId, $taskId, $page, $perPage)
This method returns all task connectors related to the run process and task.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| taskId | string | ID of the task to fetch | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 FindTaskInstanceById($taskInstanceId, $page, $perPage)
This method retrieves a task instance based on its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| taskInstanceId | string | ID of task instance to return | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInstanceCollection FindTaskInstances($page, $perPage)
This method retrieves all existing task instances.
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInstanceCollection FindTaskInstancesByInstanceAndTaskId($instanceId, $taskId)
This method retrieves task instances using the instance ID and the task ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| instanceId | string | ID of the instance | |
| taskId | string | ID of the task |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInstanceCollection FindTaskInstancesByInstanceAndTaskIdDelegated($instanceId, $taskId)
This method retrieves delegated task instances using the instance ID and the task ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| instanceId | string | ID of the instance | |
| taskId | string | ID of the task |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInstanceCollection FindTaskInstancesByInstanceAndTaskIdStarted($instanceId, $taskId)
This method retrieves started task instances using the instance ID and the task ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| instanceId | string | ID of the instance | |
| taskId | string | ID of the task |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskCollection FindTasks($processId, $page, $perPage)
This method is intended for returning a list of all tasks related to the process.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process relative to the task | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TokenCollection FindTokens($processId, $instanceId, $page, $perPage)
This method retrieves tokens related to the process and instance using the process and instance IDs
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| instanceId | string | Instance ID related to the process | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserItem FindUserById($id)
This method returns a user using its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the user to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserCollection FindUsers($page, $perPage)
This method returns all existing users in the system.
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProcessCollection1 ImportBpmnFile($bpmnImportItem)
This method imports BPMN 2.0 files. A new process(es) is/are created and its object returned back when import is successful.
| Name | Type | Description | Notes |
|---|---|---|---|
| bpmnImportItem | BpmnImportItem | JSON API with the BPMN file to import |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserItem MyselfUser($page, $perPage)
This method returns user information using a token.
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess RemoveGroupsFromTask($processId, $taskId, $taskRemoveGroupsItem)
This method removes groups from a task.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| taskId | string | Task ID | |
| taskRemoveGroupsItem | TaskRemoveGroupsItem | JSON API response with Group IDs to remove |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess RemoveUsersFromGroup($id, $groupRemoveUsersItem)
This method removes one or more users from a group.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of group to be modified | |
| groupRemoveUsersItem | GroupRemoveUsersItem | JSON API response with Users IDs to remove |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess SyncGroupsToTask($processId, $taskId, $taskSyncGroupsItem)
This method synchronizes one or more groups with a task.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| taskId | string | ID of the task to modify | |
| taskSyncGroupsItem | TaskSyncGroupsItem | JSON API response with group IDs to sync |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess SyncUsersToGroup($id, $groupSyncUsersItem)
This method synchronizes one or more users with a group.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of group to be modified | |
| groupSyncUsersItem | GroupSyncUsersItem | JSON API with array of users IDs to sync |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventItem UpdateEvent($processId, $eventId, $eventUpdateItem)
This method updates an existing event.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to retrieve | |
| eventId | string | ID of the event to retrieve | |
| eventUpdateItem | EventUpdateItem | Event object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EventConnector1 UpdateEventConnector($processId, $eventId, $connectorId, $eventConnectorUpdateItem)
This method updates the existing event connector with new parameter values.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| eventId | string | ID of the event to fetch | |
| connectorId | string | ID of the event Connector to fetch | |
| eventConnectorUpdateItem | EventConnectorUpdateItem | EventConnector object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FlowItem UpdateFlow($processId, $flowId, $flowUpdateItem)
This method updates an existing flow.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to retrieve | |
| flowId | string | ID of the flow to retrieve | |
| flowUpdateItem | FlowUpdateItem | Flow object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayItem UpdateGateway($processId, $gatewayId, $gatewayUpdateItem)
This method updates an existing gateway.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to retrieve | |
| gatewayId | string | ID of the gateway to retrieve | |
| gatewayUpdateItem | GatewayUpdateItem | Gateway object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GroupItem UpdateGroup($id, $groupUpdateItem)
This method updates an existing group.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of group to retrieve | |
| groupUpdateItem | GroupUpdateItem | Group object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InputOutputItem UpdateInputOutput($processId, $taskId, $inputoutputUid, $inputOutputUpdateItem)
This method updates an existing Input/Output object.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID related to the Input/Output object | |
| taskId | string | Task instance ID related to the Input/Output object | |
| inputoutputUid | string | ID of Input/Output to retrieve | |
| inputOutputUpdateItem | InputOutputUpdateItem | Input/Output object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InstanceItem UpdateInstance($processId, $instanceId, $instanceUpdateItem)
This method updates an existing instance.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to retrieve | |
| instanceId | string | ID of the instance to retrieve | |
| instanceUpdateItem | InstanceUpdateItem | Instance object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OauthClientItem UpdateOauthClient($userId, $clientId, $oauthClientUpdateItem)
This method updates an existing Oauth client.
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | ID of user to retrieve | |
| clientId | string | ID of Oauth client to retrieve | |
| oauthClientUpdateItem | OauthClientUpdateItem | Oauth Client object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProcessItem UpdateProcess($id, $processUpdateItem)
This method updates an existing process.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the process to retrieve | |
| processUpdateItem | ProcessUpdateItem | Process object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskItem UpdateTask($processId, $taskId, $taskUpdateItem)
This method is for updating an existing task.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| taskId | string | ID of the task to fetch | |
| taskUpdateItem | TaskUpdateItem | Task object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskConnector1 UpdateTaskConnector($processId, $taskId, $connectorId, $taskConnectorUpdateItem)
This method updates the existing task connector with new parameter values.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to fetch | |
| taskId | string | ID of the task to fetch | |
| connectorId | string | ID of the task connector to fetch | |
| taskConnectorUpdateItem | TaskConnectorUpdateItem | TaskConnector object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 UpdateTaskInstance($taskInstanceId, $taskInstanceUpdateItem)
This method updates an existing task instance.
| Name | Type | Description | Notes |
|---|---|---|---|
| taskInstanceId | string | ID of the task instance to retrieve | |
| taskInstanceUpdateItem | TaskInstanceUpdateItem | Task instance object to update |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserItem UpdateUser($id, $userUpdateItem)
This method updates an existing user.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of user to retrieve | |
| userUpdateItem | UserUpdateItem | User object for update |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]