Business Workflow APIs
- 03 Mar 2023
- 17 Minutes à lire
- Impression
- SombreLumière
- PDF
Business Workflow APIs
- Mis à jour le 03 Mar 2023
- 17 Minutes à lire
- Impression
- SombreLumière
- PDF
The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
This section contains Business Workflow specific API document. To get started, go to Workflow API Settings, select the desired Business Workflow and Business Entity to view workflow specific document. The generated endpoints 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
Create Workflow Instance
The generated endpoints include attributes required to perform a specific action based on the configuration application for the selected business workflow.
Business Workflow APIs
- The next page Create Workflow Instance opens.
Create Workflow Instance – Header
Create Workflow Instance – Path Parameter
- On the Create Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to create the workflow instance:
POST (The Post URL is used for creating 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.
- Security: Bearer Auth
Path Parameter: In the path parameter, unique workflow_id is required to identify an instance and provide its details in the response.
Create Workflow Instance – Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Create Workflow Instance – Request Body – Schema
All the mandatory attributes are marked with an asterisk symbol (*). All other parameters are dynamic in nature.
- In the** Responses** section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Workflow is deleted. No operation is permitted. |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong |
The Generate Endpoints sidebar appears at the right side of the screen.
Click View to view the workflow.
You can choose the other workflow from the drop-down next to the Select Business Workflow and Select Business Entity.
Generate Endpoints – View
Create & Send Workflow Instance
Create and directly send workflow instance to the next business entity using this endpoint. For integration purposes, one can check the Header and Request Body.
- On the Create & Send Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to send the workflow instance:
POST URL (The Post URL is used for sending 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 parameter, unique workflow_id is 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.
Create & Send Workflow Instance – Header
Create & Send Workflow Instance – Path parameter and Query parameter
- In the Request Body section, click on the Example to view the attributes required to enter.
Create & Send Workflow Instance - Request Body Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Create & Send Workflow Instance - Request Body Schema
All the mandatory attributes are marked with an asterisk symbol (*). All other parameters are dynamic in nature.
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Dispute not found for the workflow instance. |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong |
Create & Send Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several responses the code displays. You can select the Response message from the drop-down list.
Update Workflow Instance
This endpoint is used to update a workflow instance. One can refer to the Header, 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.
Update & Send Workflow Instance
This endpoint is used to Update & Send Workflow Instance to the next business entity. One can refer to the Header and Request Body for integration purposes.
- On the Update & Send Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to send the workflow instance:
POST (The Post URL is used to Update & Send 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 parameter, 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.
Update & Send Workflow Instance – Header
Update & Send 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 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 & Send Workflow Instance - Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Update & Send 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 | Dispute not found for the workflow instance. |
| 401 | This load is in cancelled status. No attribute is allowed to update. |
| 404 | Client id not found. |
| 412 | Attribute name ……required |
| 503 | Something went wrong. |
Update & Send 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.
Send Workflow Instance
This endpoint is used to send a workflow instance to the next business entity. One can refer to the Header, Request Body for integration purposes.
- On the Send Workflow Instance page, by default, the below information is available in the API documentation for each endpoint to send the workflow instance:
POST URL (The Post URL is used to send 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.
Send Workflow Instance – Header
Send Workflow Instance – Path Parameters
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Dispute not found for the workflow instance. |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong |
Send Workflow Instance - Responses
There are multiple responses for every Response code. Select a response code where you can view several responses the code displays. You can select the Response message from the drop-down list.
Revoke Workflow Instances
This endpoint is used to Revoke Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Revoke Workflow Instances page, by default, the below information is available in the API documentation for each endpoint to revoke the workflow instance:
- POST (The URL is used to revoke a 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.
Revoke Workflow Instance – Header
Revoke Workflow Instance – Path Parameters
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done. |
| 400 | Error occurred in revoking the instance. |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Revoke 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.
Receive Workflow Instance
This endpoint is used to receive a workflow instance. One can refer to the Header and Request Body for integration purposes.
- On the Receive Workflow Instance page, by default, the below information will be available in the API documentation for each endpoint to receive the workflow instance:
POST URL (The Post URL is used to receive 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.
Receive Workflow Instance – Header
Receive Workflow Instance – Path parameters
- In the Responses section, below are the different types of responses that will be generated:
| Responses | Description |
|---|---|
| 200 | Successfully done |
| 400 | Dispute not found for the workflow instance. |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong. |
Receive 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.
Reject Workflow Instance
This endpoint is used to Reject a Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Reject Workflow Instance page, by default, the below information will be available in the API documentation for each endpoint to Reject the workflow instance:
POST URL (The Post URL is used to reject 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.
Reject Workflow Instance – Header
Reject Workflow Instance – Path parameters
- In the Request Body section, click on Example to view the attributes required to enter.
| Request Body Example | Description |
|---|---|
| reject_remark | Update this section with a reason for rejection. |
Reject Workflow Instance - Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Reject 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 | Reject remark cannot be empty. |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong. |
Reject 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.
Raise Dispute
This endpoint is used to raise a dispute. One can refer to the Header, Request Body for integration purposes.
- On the Raise Dispute page, by default, the below mentioned information is available in the API documentation for each endpoint to send the workflow instance:
POST URL (The Post URL is used to raise 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.
Raise Dispute – Header
Raise Dispute – Path parameters
- In the Request Body section, click on Example to view the attributes required to enter.
| Request Body Example | Description |
|---|---|
| comment | Enter the comment as applicable. |
Raise Dispute - Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Raise 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 | Dispute not found for the workflow instance. |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong. |
Raise 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.
Withdraw Dispute
This endpoint is used to withdraw a dispute. One can refer to the Header and Request Body for integration purposes.
- On the Withdraw Dispute page, by default, the below information is available in the API documentation for each endpoint to send the workflow instance:
- POST URL (The Post URL is used to withdraw 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.
Withdraw Dispute – Header
Withdraw Dispute – Path Parameters
- In the Request Body section, click on Example to view the attributes required to enter.
| Request Body Example | Description |
|---|---|
| comment | Users can give remarks in this field. |
Withdraw Dispute - Request Body - Example
- To view the properties of the attributes displayed in Example section, click on Schema.
Withdraw 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 | Invalid user for withdrawing dispute |
| 401 | Invalid token |
| 404 | Client id not found. |
| 412 | Validation errors/Invalid Arguments. |
| 503 | Something went wrong. |
Withdraw 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.
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 send the 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 send the 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.
Get Callbacks for a Business Workflow Instance
This endpoint is used to Get Callbacks for a Workflow Instance. One can refer to the Header and Request Body for integration purposes.
- On the Get Callbacks 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 Callbacks 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 Parameter: The query parameters help the user in filtering and organizing the data.
Get Callbacks for a Workflow Instance – Header
Get Callbacks 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 | Pending agreement found for user. |
| 401 | Invalid token |
| 404 | Client id not found |
| 412 | Validation errors/Invalid Arguments |
| 503 | Something went wrong |
Get Callbacks 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.
Cet article vous a-t-il été utile ?