Skip to main content

Start Process

This endpoint allows you to start new process of workflow, the first step is starting on call of this endpoint.

Endpoint: /api/v1/processes/start

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "workflowId": "string",
  "params": {
    "additionalProp1": {
      "strValue": "string",
      "longValue": "number",
      "doubleValue": "number",
      "type": "enum"
    },
    "additionalProp2": {
      "strValue": "string",
      "longValue": "number",
      "doubleValue": "number",
      "type": "enum"
    },
    "additionalProp3": {
      "strValue": "string",
      "longValue": "number",
      "doubleValue": "number",
      "type": "enum"
    }
  }
}
info

In params user should specify process mandatory params for first step

workflowId (required): id of workflow for which the process is starting. params: Parameters dictionary

Responses​

200 (OK) The request was successful, and the server has created the process for workflow, started first step. It means that first step status will be STARTED, and others are PENDING

Body:

{
  "message": "string",
  "timestamp": "2024-03-29T12:39:44.745Z",
  "data": {
    "processId": "string",
    "processStepId": "string",
    "params": {
      "additionalProp1": {
        "strValue": "string",
        "longValue": "number",
        "doubleValue": "number",
        "type": "enum"
      },
      "additionalProp2": {
        "strValue": "string",
        "longValue": "number",
        "doubleValue": "number",
        "type": "enum"
      },
      "additionalProp3": {
        "strValue": "string",
        "longValue": "number",
        "doubleValue": "number",
        "type": "enum"
      }
    }
  },
  "version": "string"
}

processId: Started process id. processStepId: Started process step id params: Parameters dictionary

401 (Unauthorized) This response is returned if the request is not authorized.

Body:

{
  "message": "Unauthorized request",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": "string",
  "version": "string"
}

412 (Precondition Failed) This response is returned if a precondition is not met.

Body:

{
  "message": "Precondition failed",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "version": "string"
}

500 (Internal Server Error) This response is returned if an unexpected internal server error occurs.

Body:

{
  "message": "Internal Server Error",
  "timestamp": "2023-09-28T15:37:14.223Z",
  "data": "string",
  "version": "string"
}