Skip to main content

Restart Failed Step

This endpoint allows you to failed process step.

Endpoint: /api/v1/processes/restart-failed-step

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "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"
    }
  }
}

processStepId: (required): id of process step to fail. params: Parameters dictionary

Responses​

200 (OK) The request was successful, and the server has calling failed step's delegated method and changing the failed process step's status to STARTED

Body:

{
  "message": "string",
  "timestamp": "2024-03-29T13:14:52.856Z",
  "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"
}