Business Workflow APIs
- 03 Mar 2023
- 11 読む分
- 印刷する
- 闇光
- PDF
Business Workflow APIs
- 更新日 03 Mar 2023
- 11 読む分
- 印刷する
- 闇光
- PDF
The content is currently unavailable in Ja - 日本語. You are viewing the default English version.
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
To get started, go to Workflow API Settings, select the desired Business Workflow and Business Entity to view workflow specific document. The generated endpoints would contain attributes which are required to perform specific action in the configured business workflow. By default, no endpoints are available in this section, follow the below mentioned steps:
- Select Business Workflow
- Select Business Entity
- View Workflow specific Endpoints
Business Workflow APIs
Update Workflow Instance
This endpoint is used to update a workflow instance. One can refer to the Header and Request Body for integration purposes.
- On the Update Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to update the workflow instance:
PATCH (The URL is used to Update a Workflow Instance).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Example – Authorization: Bearer {{Access token}}
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Update Workflow Instance – Header
Update Workflow Instance – Path parameters
- In the Request Body section, click on Example to view the attributes required to enter.
| Request Body Example | Description |
|---|---|
| CR_Order_Number* | This field is mandatory to update. |
All the mandatory attributes are marked with an asterisk symbol (*). All other parameters are dynamic in nature and may or may not be applicable for a business entity.
Update Workflow Instance - Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Update Workflow Instance - Request Body - Schema
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Error occurred in updating the instance |
| 401 | Invalid token |
| 404 | Client id not found. |
| 409 | Some asset attributes are not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong. |
Update Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Resolve Dispute
This endpoint is used to resolve a dispute. One can refer to the Header and Request Body for integration purposes.
- On the Resolve Dispute page, by default, the below information is available in the API documentation for each endpoint to resolve the workflow instance:
POST URL (The Post URL is used to resolve a dispute).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Resolve Dispute – Header
Resolve Dispute – Path Parameters
- In the Request Body section, click on Example to view the attributes required enter.
| Request Body Example | Description |
|---|---|
| Comment | Enter the comment as required. |
Resolve Dispute - Request Body Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Resolve Dispute - Request Body Schema
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Workflow instance id is invalid |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong. |
Resolve Dispute - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Hard Update Workflow Instance
This endpoint is used to Hard Update Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Hard Update Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to hard update the workflow instance:
PATCH (The URL is used to Hard Update a Workflow Instance).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameter: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Query Parameter: The query parameter helps the user in filtering and organizing the data.
Hard Update Workflow Instance – Header
Hard Update Workflow Instance – Path Parameters and Query parameter
- In the Request Body section, click on Example to view the attributes required to enter.
| Request Body Example | Description |
|---|---|
| CR_Order_Number* | This field is mandatory to update. |
All the important sections are marked with an asterisk symbol (*). All other parameters are dynamic in nature and may or may not be applicable for a business entity.
Hard Update Workflow Instance - Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Hard Update Workflow Instance - Request Body - Schema
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | User is not associated to the given workflow instance id |
| 401 | Invalid token |
| 404 | Client id not found. |
| 409 | Some asset attributes are not found |
| 412 | Attribute name ……required. |
| 503 | Something went Wrong. |
Hard Update Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Get Activities for a Business Workflow Instance
This endpoint is used to Get activities for a Business Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Get Activities for a Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to get activities for a workflow instance:
GET (The URL is used to Get Activities for a Workflow Instance).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Query Parameters: The query parameters help the user in filtering and organizing the data.
Get Activities for a Workflow Instance – Header
Get Activities for a Workflow Instance – Path Parameters and Query Parameters
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Workflow Instance id is invalid |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Get Activities for a Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Get Comments for a Business Workflow Instance
This endpoint is used to Get comments for a Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Get Comments for a Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to send the workflow instance:
GET (The URL is used to Get Comments for a Workflow Instance).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Query Parameters: The query parameters help the user in filtering and organizing the data.
Get Comments for a Workflow Instance – Header
Get Comments for a Workflow Instance – Path Parameters and Query Parameters
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Workflow Instance id is invalid |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Get Comments for a Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Add Comments in a Business Workflow Instance
This endpoint is used to Add Comments in a Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Add comments in a Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to add comments in a business workflow instance:
POST (The URL is used to Add comments in a Workflow Instance).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Add Comments in a Workflow Instance -Header
Add Comments in a Workflow Instance -Path Parameters
- In the Request Body section, click on Example to view the parameters required to get the access token:
| Request Body Example | Description |
|---|---|
| comment | Enter the comment as required |
Add Comments in a Workflow Instance -Request Body -Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Add Comments in a Workflow Instance -Request Body -Schema
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done. |
| 400 | Workflow is deactivated. No operation is permitted. |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Add Comments in a Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Activate Workflow Instances
This endpoint is used to Activate the Workflow Instances which are currently Inactive. One can refer to the Header and Request Body for integration purposes.
- On the Activate Workflow Instances page, by default, the below information is available in the API documentation for each endpoint to activate the workflow instances:
PATCH (The URL is used to Activate Workflow Instances).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Activate Workflow Instance -Header and Path Parameter
- In the Request Body section, click on Example to view the parameters required to get the access token:
| Request Body Example | Description |
|---|---|
| workflow_instances* | Users can enter the workflow instances (tag_id) in this field to activate the workflow instances. |
All the important sections are marked with an asterisk symbol (*). All other parameters are dynamic in nature and may or may not be applicable for a business entity.
Activate Workflow Instance - Request Body – Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Activate Workflow Instance - Request Body - Schema
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done. |
| 400 | User is not associated to the given workflow instance id |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Activate Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
Deactivate Workflow Instances
This endpoint is used to Deactivate the Workflow Instances which are currently active. One can refer to the Header and Request Body for integration purposes.
- On the Deactivate Workflow Instances page, by default, the below information is available in the API documentation for each endpoint to send the workflow instance:
POST (The URL is used to Deactivate Workflow Instances).
Header:
Security: Bearer Auth
- This parameter is required to authenticate the user by a token which needs to be passed in as a header.
Path Parameters: In the path parameters, unique workflow_id and tag_id are required to identify an instance and provide its details in the response.
Deactivate Workflow Instance – Header and Path parameter
- In the Request Body section, click on Example to view the parameters required to get the access token:
| Request Body Example | Description |
|---|---|
| workflow_instances* | Users can enter the workflow instances in this field. |
All the mandatory attributes are marked with an asterisk symbol (*). All parameters are dynamic in nature and may or may not be applicable for a business entity.
Deactivate Workflow Instance – Request Body – Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Deactivate Workflow Instance – Request Body - Schema
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done. |
| 400 | Movable product version mismatch |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Deactivate Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several response messages the code displays. You can select the Response message from the drop-down list.
この記事は役に立ちましたか?