Skip to content

WorkflowLogEntryDto

Endpoints · All schemas

FieldRequiredDescription
atYesWorkflow run date/time
attemptYes0 for the first attempt, 1 for the automatic retry, then manual retries
errorNoWhy the run failed, without stored credentials
errorCodeNoSee definition below
idYesWorkflow log entry ID
lastStepNoLast step ran, if the workflow ended early
resultYesSee definition below
runIdYesRun ID shared by every attempt of one run
triggerDataIdNoWorkflow trigger data ID

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: WorkflowRunErrorCode, WorkflowResult

{
  "properties": {
    "at": {
      "description": "Workflow run date/time",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    },
    "attempt": {
      "description": "0 for the first attempt, 1 for the automatic retry, then manual retries",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "error": {
      "description": "Why the run failed, without stored credentials",
      "type": "string"
    },
    "errorCode": {
      "$ref": "#/components/schemas/WorkflowRunErrorCode"
    },
    "id": {
      "description": "Workflow log entry ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "lastStep": {
      "description": "Last step ran, if the workflow ended early",
      "properties": {
        "index": {
          "description": "Index of the step in the workflow",
          "maximum": 9007199254740991,
          "minimum": 0,
          "type": "integer"
        },
        "method": {
          "description": "Method of the step",
          "type": "string"
        }
      },
      "required": [
        "method",
        "index"
      ],
      "type": "object"
    },
    "result": {
      "$ref": "#/components/schemas/WorkflowResult"
    },
    "runId": {
      "description": "Run ID shared by every attempt of one run",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "triggerDataId": {
      "description": "Workflow trigger data ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    }
  },
  "required": [
    "at",
    "attempt",
    "id",
    "result",
    "runId"
  ],
  "type": "object"
}