Business Workflow APIs
  • 03 Mar 2023
  • 17 Minutos para leer
  • Oscuro
    Ligero
  • PDF

Business Workflow APIs

  • Oscuro
    Ligero
  • PDF

The content is currently unavailable in Spanish. You are viewing the default English version.
Resumen del artículo

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:

  1. Select Business Workflow
  2. Select Business Entity
  3. View Workflow specific Endpoints

image.png

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.

image.png

Business Workflow APIs

  1. The next page Create Workflow Instance opens.

image.png

Create Workflow Instance – Header

image.png

Create Workflow Instance – Path Parameter

  1. 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.
  • Path Parameter: In the path parameter, unique workflow_id is required to identify an instance and provide its details in the response.

image.png

Create Workflow Instance – Request Body - Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Create Workflow Instance – Request Body – Schema

All the mandatory attributes are marked with an asterisk symbol (*). All other parameters are dynamic in nature.

  1. In the** Responses** section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Workflow is deleted. No operation is permitted.
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong
  1. The Generate Endpoints sidebar appears at the right side of the screen.

  2. Click View to view the workflow.

  3. You can choose the other workflow from the drop-down next to the Select Business Workflow and Select Business Entity.

image.png

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.

  1. 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.

image.png

Create & Send Workflow Instance – Header

image.png

Create & Send Workflow Instance – Path parameter and Query parameter

  1. In the Request Body section, click on the Example to view the attributes required to enter.

image.png

Create & Send Workflow Instance - Request Body Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Create & Send Workflow Instance - Request Body Schema

All the mandatory attributes are marked with an asterisk symbol (*). All other parameters are dynamic in nature.

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Dispute not found for the workflow instance.
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong

image.png

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.

  1. 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}}
  • 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.

image.png

Update Workflow Instance – Header

image.png

Update Workflow Instance – Path parameters

  1. In the Request Body section, click on Example to view the attributes required to enter.
Request Body ExampleDescription
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.

image.png

Update Workflow Instance - Request Body - Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Update Workflow Instance - Request Body - Schema

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Error occurred in updating the instance
401Invalid token
404Client id not found.
409Some asset attributes are not found.
412Validation errors/Invalid Arguments.
503Something went wrong.

image.png

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.

  1. 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}}
  • 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.

image.png

Update & Send Workflow Instance – Header

image.png

Update & Send Workflow Instance – Path Parameters and Query Parameter

  1. In the Request Body section, click on Example to view the attributes required to enter.
Request Body ExampleDescription
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.

image.png

Update & Send Workflow Instance - Request Body - Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Update & Send Workflow Instance - Request Body - Schema

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Dispute not found for the workflow instance.
401This load is in cancelled status. No attribute is allowed to update.
404Client id not found.
412Attribute name ……required
503Something went wrong.

image.png

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.

  1. 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.

image.png

Send Workflow Instance – Header

image.png

Send Workflow Instance – Path Parameters

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Dispute not found for the workflow instance.
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong

image.png

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.

  1. 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.

image.png

Revoke Workflow Instance – Header

image.png

Revoke Workflow Instance – Path Parameters

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done.
400Error occurred in revoking the instance.
401Invalid token
404Client id not found
412Validation errors/Invalid Arguments
503Something went wrong

image.png

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.

  1. 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.

image.png

Receive Workflow Instance – Header

image.png

Receive Workflow Instance – Path parameters

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Dispute not found for the workflow instance.
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong.

image.png

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.

  1. 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.

image.png

Reject Workflow Instance – Header

image.png

Reject Workflow Instance – Path parameters

  1. In the Request Body section, click on Example to view the attributes required to enter.
Request Body ExampleDescription
reject_remarkUpdate this section with a reason for rejection.

image.png

Reject Workflow Instance - Request Body - Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Reject Workflow Instance - Request Body - Schema

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Reject remark cannot be empty.
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong.

image.png

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.

  1. 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.

image.png

Raise Dispute – Header

image.png

Raise Dispute – Path parameters

  1. In the Request Body section, click on Example to view the attributes required to enter.
Request Body ExampleDescription
commentEnter the comment as applicable.

image.png

Raise Dispute - Request Body - Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Raise Dispute - Request Body - Schema

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Dispute not found for the workflow instance.
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong.

image.png

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.

  1. 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.

image.png

Withdraw Dispute – Header

image.png

Withdraw Dispute – Path Parameters

  1. In the Request Body section, click on Example to view the attributes required to enter.
Request Body ExampleDescription
commentUsers can give remarks in this field.

image.png

Withdraw Dispute - Request Body - Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Withdraw Dispute - Request Body - Schema

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Invalid user for withdrawing dispute
401Invalid token
404Client id not found.
412Validation errors/Invalid Arguments.
503Something went wrong.

image.png

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.

  1. 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.

image.png

Get Activities for a Workflow Instance – Header

image.png

Get Activities for a Workflow Instance – Path Parameters and Query Parameters

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Workflow Instance id is invalid
401Invalid token
404Client id not found
412Validation errors/Invalid Arguments
503Something went wrong

image.png

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.

  1. 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.

image.png

Get Comments for a Workflow Instance – Header

image.png

Get Comments for a Workflow Instance – Path Parameters and Query Parameters

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done
400Workflow Instance id is invalid
401Invalid token
404Client id not found
412Validation errors/Invalid Arguments
503Something went wrong

image.png

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.

  1. 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.

image.png

Add Comments in a Workflow Instance -Header

image.png

Add Comments in a Workflow Instance -Path Parameters

  1. In the Request Body section, click on Example to view the parameters required to get the access token:
Request Body ExampleDescription
commentEnter the comment as required

image.png

Add Comments in a Workflow Instance -Request Body -Example

  1. To view the properties of the attributes displayed in Example section, click on Schema.

image.png

Add Comments in a Workflow Instance -Request Body -Schema

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done.
400Workflow is deactivated. No operation is permitted.
401Invalid token
404Client id not found
412Validation errors/Invalid Arguments
503Something went wrong

image.png

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.

  1. 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.

image.png

Get Callbacks for a Workflow Instance – Header

image.png

Get Callbacks for a Workflow Instance – Path Parameters and Query Parameters

  1. In the Responses section, below are the different types of responses that will be generated:
ResponsesDescription
200Successfully done.
400Pending agreement found for user.
401Invalid token
404Client id not found
412Validation errors/Invalid Arguments
503Something went wrong

image.png

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.


¿Te ha sido útil este artículo?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.