/api/Workflows/Activity
Get
Summary:
Returns all the activities according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activity list. | List of Activity |
Post
Summary:
Creates an activity.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the activity creation. | ActivityCreatedResult |
/api/Workflows/Activity/{id}
Get
Summary:
Returns an activity corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the activity. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activity. | Activity |
Put
Summary:
Updates an activity.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the activity to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the activity update. | ActivityUpdatedResult |
Delete
Summary:
Deletes an activity.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the activity to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the activity delete. | ActivityDeletedResult |
/api/Workflows/ActivityInstance
Get
Summary:
Returns all the activity instances according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activity instance list. | List of ActivityInstance |
/api/Workflows/ActivityInstance/{id}
Get
Summary:
Returns the activity instances corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the ActivityInstance. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activity instances. | ActivityInstance |
/api/Workflows/ActivityTemplate
Get
Summary:
Returns all the activityTemplates according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activityTemplate list. | List of ActivityTemplate |
/api/Workflows/ActivityTemplate/{id}
Get
Summary:
Returns an activityTemplate corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the activityTemplate. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activityTemplate. | ActivityTemplate |
/api/Workflows/ActivityTemplateState
Get
Summary:
Returns all the activityTemplateStates according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activityTemplateState list. | List of ActivityTemplateState |
/api/Workflows/ActivityTemplateState/{id}
Get
Summary:
Returns an activityTemplateState corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the activityTemplateState. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activityTemplateState. | ActivityTemplateState |
/api/Workflows/ActivityTemplateTransition
Get
Summary:
Returns all the activityTemplateTransitions according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activityTemplateTransition list. | List of ActivityTemplateTransition |
/api/Workflows/ActivityTemplateTransition/{id}
Get
Summary:
Returns an activityTemplateTransition corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the activityTemplateTransition. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The activityTemplateTransition. | ActivityTemplateTransition |
/api/Workflows/Workflow
Get
Summary:
Returns all the workflows according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The workflow list. | List of Workflow |
Post
Summary:
Creates a workflow.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the workflow creation. | WorkflowCreatedResult |
/api/Workflows/Workflow/{id}
Get
Summary:
Returns a workflow corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the workflow. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The workflow. | Workflow |
Put
Summary:
Updates a workflow.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the workflow to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the workflow update. | WorkflowUpdatedResult |
Delete
Summary:
Deletes a workflow.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the workflow to delete. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the workflow delete. | WorkflowDeletedResult |
/api/Workflows/WorkflowInstance
Get
Summary:
Returns all the activities according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| PageSize | Page size. | False | | |
| ContinuationToken | ContinuationToken returned by previous page request. | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The workflowInstance list. | List of WorkflowInstance |
Post
Summary:
Starts a new workflow instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the workflowInstance creation. | WorkflowInstanceStartedResult |
/api/Workflows/WorkflowInstance/{id}
Get
Summary:
Returns a workflowInstance corresponding to the provided identifier and its information according to the provided query.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the workflowInstance. | True | | |
| squery | Query compliant to the API query grammar. | False | | |
| Path | Represents the permission path. | False | | |
| QueryRootEntityType | Defines the query root entity type. | False | | |
| QueryBinding | Defines the query binding. | False | | |
| ApplyPostCondition | If true, use PostCondition access control rules. | False | | |
| AllowedAllJoinQuery | | False | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The workflowInstance. | WorkflowInstance |
Put
Summary:
Resume an running workflow instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the workflowInstance to update. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the workflowInstance update. | WorkflowInstanceResumedResult |
Delete
Summary:
Purges an aborted workflow instance.
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| id | Identifier of the workflowInstance to purge. | True | | |
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 200 | The result of the workflowInstance purge. | WorkflowInstancePurgedResult |
/api/Workflows/WorkflowInstance/Bulk
Post
Parameters:
| Name | Description | Required | Type | Reference |
|---|
| api-version | The requested API version | True | | |
Responses:
| Code | Description | Reference |
|---|
| 202 | Accepted | |