Task Log Object

The Task Log objects represent additional information regarding the execution of the task. Examples of such information include:

  • The task has been started.

  • The task has failed due to an issue.

  • The task is currently processing a specific step, for example, the 3rd step out of 5.

This object contains the following attributes:

Field Name
Data Type
Description

id

string

The ID of the task log record.

Example: TLR-1930-6351-9137-5141

task

task

A reference to the task containing this log.

Example:

severity

string

The severity of the task log.

Example: Warning

message

string

Message template.

Example:

timestamp

date

The time of the log record.

Example: 2025-09-11 13:40:13.515Z

progress

decimal

The task progress in percentage.

Example: 21.3

eta

string (ISO 8601 datetime)

The estimation of finishing for the task, if available.

Example: 2025-09-12 13:40:13.515Z

parameters

object

Optional message parameters.

Example:

Example

{
    "id": "TLR-1930-6351-9137-5141",
    "revision": 1,
    "task": {
        "id": "TSK-5498-1544-6054-5440",
        "name": "Transferring the buyer to a different account",
        "revision": 1,
        "status": "Completed",
        "code": "accounts.buyers.transfer"
    },
    "progress": 0,
    "eta": "2025-09-12 13:40:13.515Z",
    "severity": "Info",
    "message": "Starting buyer '{{BuyerId}}' transfer to '{{TargetAccountId}}'.",
    "timestamp": "2025-09-11T13:40:13.515Z",
    "parameters": {
        "BuyerId": "BUY-4230-6788",
        "TargetAccountId": "ACC-4952-6625"
    }
}

Last updated

Was this helpful?