Generic APIs
  • 03 Mar 2023
  • 4 読む分
  • PDF

Generic APIs

  • PDF

The content is currently unavailable in Ja - 日本語. You are viewing the default English version.
記事の要約

Click on the Generic API Documentation link, you will be redirected to a new tab to view Generic APIs.

image.png

Generic APIs

Get Workflow List

This endpoint is used to fetch the list of all the permissioned workflows. User can refer to the Header and Query parameters for integration Purposes.

  1. Inside Generic APIs, on the Get Workflow List page, by default, the below information is available in the API documentation for each endpoint to send the Generic APIs:
  • GET (The URL is used to get workflow list).
  • Header
  • Security: Bearer Auth
    • This parameter is required to authenticate the user by a token which needs to be passed in as a header.
    • Use the Get Access Token endpoint to generate the access token.
  • Query Parameters: The query parameters help the user in filtering and organizing the data.

image.png

Get Workflow List

  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.
503Something went wrong

image.png

Get Workflow List - 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.

Search Workflow instances

This endpoint is used to search Workflow Instances. One can refer to the Header and Request Body for integration purposes.

  1. On the Search Workflow Instances page, by default, the below information is available in the API documentation for each endpoint to send the Generic APIs:
  • POST (The URL is used to Search 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 Parameter: In path parameter, unique workflow_id is 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

Search Workflow Instance

image.png

Search Workflow Instance – Query parameter

  1. In the Request Body section, click on Example to view the parameters required to get the access token:
Request BodyDescription
creation_time_start*Enter creation time start date in the YYYY-MM-DD format in this field.
creation_time_end*Enter creation time end date in the YYYY-MM-DD format in this field.

All the important sections are marked with an astrisk symbol (*). All other parameters are dynamic in nature and may or may not be applicable for a business entity.

image.png

Search Workflow Instance –Request Body Example

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

image.png

Search 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 id is invalid.
401Invalid token
404Id is not found in system
412Validation errors/Invalid Arguments.
503Something went wrong

image.png

Search 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 Instance Details

This endpoint is used to Get Instance Details. One can refer to the Header and Request Body for integration purposes.

  1. On the Get Instance Details page, by default, the below information is available in the API documentation for each endpoint to send the Generic APIs:
  • GET (The URL is used to Get Instance Details).

  • 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 parameter, 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 Instance Details – Header

image.png

Get Instance Details – Path Parameters

image.png

Get Instance Details – 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.
503Something went wrong

image.png

Get Instance Details - 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 Business Entity List

This endpoint is used to Get Business Entity List. One can refer to the Header and Request Body for integration purposes.

  1. On the Get Business Entity List page, by default, the below information is available in the API documentation for each endpoint for Generic APIs:
  • GET (The URL is used to Get Business Entity List).

  • 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 Parameters: The query parameters help the user in filtering and organizing the data.

image.png

Get Business Entity List – Header

image.png

Get Business Entity List – Path Parameter and Query Parameters

  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.
401Group with the provided id is not assigned to participant.
404Workflow with the provided id is not found.
412Validation errors/Invalid Arguments.
503Something went wrong.

image.png

Get Business Entity - 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.


この記事は役に立ちましたか?

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.