Skip to main content

Create log

This endpoint allows you to create log with rest api.

Endpoint: /api/v1/logs

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "processStepId": "string",
  "type": "enum",
  "params": {
    "additionalProp1": "object",
    "additionalProp2": "object",
    "additionalProp3": "object"
  },
  "message": "string",
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "infos": [
    "string"
  ],
  "trace": "string"
}

processStepId: (required): id of process step to fail. params: Parameters dictionary message: Can be the message of exception if exists trace: Can be the trace of exception if exists errors: Errors string list warnings: Warnings string list infos: Informative string list

Responses​

200 (OK) The request was successful, and the server creating log

Body:

{
  "message": "Success",
  "timestamp": "2024-03-29T17:16:14.511618Z",
  "data": {
    "creationTimestamp": "2024-03-29T17:16:14.450253Z",
    "updatedTimestamp": null,
    "processStepId": "fb42a918-21bc-4ac7-ad86-3cbba21907a9",
    "processId": "9c0df09e-e95c-4eb4-a1db-cd3e83d9911d",
    "workflowId": "48509e77-7710-4143-bb86-56b841b9f87a",
    "type": "ERROR",
    "params": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "message": "string",
    "errors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "infos": [
      "string"
    ],
    "trace": "string"
  },
  "version": "1"
}

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