Flows
Get Flows
GET
https://api.YOUR_TENANT.appmixer.cloud/flows
Return all flows of a user.
curl "https://api.appmixer.com/flows" -H "Authorization: Bearer [ACCESS_TOKEN]"
Query Parameters
Name | Type | Description |
---|---|---|
filter | string | Filter flows by their property values. Example: "userId:123abc" returns only flows who's owner is the user with ID "123abc" (i.e. shared flows are excluded). Note that you can also search on nested fields. This is especially useful with the |
sharedWithPermissions | string | Filter flows by their sharing setting. Example: "read,start". All possible permission are currently "read", "start", "stop". |
projection | string | Exclude flow object properties. Example: "-flow,-thumbnail". |
sort | string | Sorting parameter. Can be any flow object property followed by semicolon and 1 (ascending), -1 (descending). Example: "mtime:-1". |
pattern | string | A term to filter flows containing pattern in their name or flowId property. |
offset | number | The index of the first item returned. Default is 0. Useful for paging. |
limit | number | Maximum items returned. Default is 100. Useful for paging. |
Get Flow
GET
https://api.YOUR_TENANT.appmixer.cloud/flows/:id
Return one flow.
curl "https://api.appmixer.com/flows/9089f275-f5a5-4796-ba23-365412c5666e" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Name | Type | Description |
---|---|---|
id | string |
Get Flows Count
GET
https://api.YOUR_TENANT.appmixer.cloud/flows/count
Return the number of all flows of a user.
curl "https://api.appmixer.com/flows/count" -H "Authorization: Bearer [ACCESS_TOKEN]"
Create Flow
POST
https://api.YOUR_TENANT.appmixer.cloud/flows
Create a new flow.
curl -XPOST "https://api.appmixer.com/flows" -H "Content-Type: application/json" -d '{ "flow": FLOW_DESCRIPTOR, "name": "My Flow #1", "customFields": { "category": "healthcare" } }'
Request Body
Name | Type | Description |
---|---|---|
name | string | Name of the flow. |
customFields | object | An object with any custom properties. This is useful for storing any custom metadata and later using the metadata values to filter returned flows. |
thumbnail | string | Flow thumbnail image. |
flow | object | Flow descriptor. |
Update Flow
PUT
https://api.YOUR_TENANT.appmixer.cloud/flows/:id
Update an existing flow.
curl -XPUT "https://api.appmixer.com/flows/9089f275-f5a5-4796-ba23-365412c5666e" -H "Content-Type: application/json" -d '{ "flow": FLOW_DESCRIPTOR, "name": "My Flow #2" }'
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Flow ID. |
Request Body
Name | Type | Description |
---|---|---|
object | An object with |
Delete Flow
DELETE
https://api.YOUR_TENANT.appmixer.cloud/flows/:id
Delete an existing flow.
curl -XDELETE "https://api.appmixer.com/flows/9089f275-f5a5-4796-ba23-365412c5666e" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Flow ID. |
Clone Flow
POST
https://api.YOUR_TENANT.appmixer.cloud/flows/:id/clone
Clone a flow
Path Parameters
Name | Type | Description |
---|---|---|
id* | String | Flow ID |
Request Body
Name | Type | Description |
---|---|---|
prefix | String | Prefix for flow clone name. The original flow name will be used with this prefix as a name for the new flow. |
projection | String | Properties to be filtered from the flow model. Example: "-thumbnail,-sharedWith". With this projection string, the thumbnail and sharedWith property will not be cloned. |
connectAccounts | Boolean | If user accounts (like Gmail account for SendEmail component) connected to the source flow components should also be connected to cloned flow components. Default is false. Accounts can be connected only if the owner of the cloned flow is the same as the owner of the original flow. |
isTemplateInstance | Boolean | If source flow is an instance of template (related to Integrations). Default is false |
Start/Stop Flow
POST
https://api.YOUR_TENANT.appmixer.cloud/flows/:id/coordinator
Start or Stop an existing flow.
curl -XPOST "https://api.appmixer.com/flows/9089f275-f5a5-4796-ba23-365412c5666e" -H "Content-Type: application/json" -d '{ "command": "start" }'
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Flow ID. |
Request Body
Name | Type | Description |
---|---|---|
command | string | The command to send to the flow coordinator. It can be either |
Send GET request to a component
GET
https://api.YOUR_TENANT.appmixer.cloud/flows/:flowId/components/:componentId
Query Parameters
Name | Type | Description |
---|---|---|
enqueueOnly | Boolean | If "true" then the response to this request will be returned as soon as the requests is enqueued in the engine. It will not wait for the component to process the request and create the response. The response code is 202 in this case. The default value is "false". |
Send POST request to a component
POST
https://api.YOUR_TENANT.appmixer.cloud/flows/:flowId/components/:componentId
Query Parameters
Name | Type | Description |
---|---|---|
enqueueOnly | Boolean | If "true" then the response to this request will be returned as soon as the requests is enqueued in the engine. It will not wait for the component to process the request and create the response. The response code is 202 in this case. The default value is "false". |
Send PUT request to a component
PUT
https://api.YOUR_TENANT.appmixer.cloud/flows/:flowId/components/:componentId
Query Parameters
Name | Type | Description |
---|---|---|
enqueueOnly | Boolean | If "true" then the response to this request will be returned as soon as the requests is enqueued in the engine. It will not wait for the component to process the request and create the response. The response code is 202 in this case. The default value is "false". |
Send DELETE request to a component
DELETE
https://api.appmixer.com/flows/:flowId/components/:componentId
Query Parameters
Name | Type | Description |
---|---|---|
enqueueOnly | Boolean | If "true" then the response to this request will be returned as soon as the requests is enqueued in the engine. It will not wait for the component to process the request and create the response. The response code is 202 in this case. The default value is "false". |
Last updated