Home
Shared capabilities
Logbook
Logbook REST APIs
API: Create single or multiple logs

API: Create single or multiple logs

Last updated
Save as PDF

POST /api/rest/v1/logs

Create a single log or multiple logs (maximum of 50 per request).

Notes:

You can create up to 50 logs in a single request.
To retrieve log_type details with custom and system attribute configurations, use the API: log types and configurations endpoint.
Logs that fail validation appear in the Failed array with a corresponding failed_message that explains the reason.

Security

Bearer Token Authentication (BearerAuth)

Headers

Key	Value	Description	Required
Authorization	Bearer <token>	The bearer token for authentication and access.	Yes

Request body

Content-Type: application/json

Schema Definitions

Field	Type	Required	Description
`logs`	Array	Yes	A list of logs to be created (max 50 entries). Each item follows the structure below.

Log object structure (inside logs[])

Field	Type	Required	Description
`log_types_id`	Integer	Yes	The ID of the log type.
`name`	String	Yes	Name or title of the log.
`transferred_from_id`	Integer	No	The ID of the user from whom the log is transferred.
`custom_attribute_values`	Array of `LogCustomAttributeValueInput`	No	List of custom attribute values to set.
`system_attribute_values`	Array of `LogSystemAttributeValueInput`	No	List of system attribute values to set.
`app_context`	Array of `AppContext`	Yes	The context of where this log belongs (e.g., workspace/work).

AppContext

Field	Type	Required	Description
`container_id`	Integer	Yes	ID of the container
`container_source`	String	Yes	Source of the container
`container_type`	String	Yes	Type of the container

LogCustomAttributeValueInput

Field	Type	Required	Description
`ca_config_id`	Integer	Yes	Custom attribute configuration ID
`section_ca_id`	Integer	Yes	ID of the section where the attribute belongs
`value`	String/Object/Array	Yes	Value can be a string, object (id/label/value), or array of such objects

Each value inside values may include:

Sub-field	Type	Description
`id`	Integer	System attribute value ID
`sa_id`	Integer	System attribute ID
`value`	String / Object / Array	Can be a string, select object (`{id, label, value}`), user object, artifact array, or date

Request body example

"logs": [
    {
      "log_types_id": 0,
      "name": "string",
      "transferred_from_id": 0,
      "custom_attribute_values": [
        {
          "ca_config_id": 574,
          "section_ca_id": 1969,
          "value": "2025-05-22"
        }
      ],
      "system_attribute_values": [
        {
          "value": {
            "id": 1,
            "is_visible": true,
            "label": "New",
            "value": "New"
          },
          "sa_id": 2,
          "id": 73
        },
        {
          "value": 2,
          "sa_id": 7,
          "id": 78
        },
        {
          "value": 2,
          "sa_id": 6,
          "id": 77
        },
        {
          "value": "2025-07-01",
          "sa_id": 5,
          "id": 76
        },
        {
          "value": "<p>ac</p>",
          "sa_id": 1,
          "id": 72
        }
      ],
      "app_context": [
        {
          "container_id": 0,
          "container_source": "string",
          "container_type": "string"
        }
      ]
    }
  ]
}

Response

Status Code: 200 OK

Content-Type: application/json

Returns a list of successful and failed logs.

Response example

{
  "rest_add_log": {
    "Data": [
      {
        "id": 0,
        "name": "string",
        "log_type": {
          "id": 18,
          "type_name": "Decision",
          "description": "NO",
          "is_published": false,
          "log_type_categories_id": 5,
          "allow_email_notification": true
        },
        "custom_attribute_values": {
          "values": {
            "574": {
              "ca_config_id": 574,
              "section_ca_id": 1969,
              "value": {
                "id": "UUID",
                "label": "New 02",
                "value": "New 02"
              }
            }
          }
        },
        "system_attribute_values": {
          "values": {
            "1": {
              "id": 3165,
              "sa_id": 1,
              "value": {
                "id": 1,
                "is_visible": true,
                "label": "New",
                "value": "New"
              }
            }
          }
        },
        "created_at": "2025-06-20T09:29:48.899Z",
        "transferred_from": {
          "id": 123,
          "name": "User A",
          "type": "Decision"
        },
      }
    ],
    "Failed": [
      {
        "failed_message": "string",
        "log_types_id": 0,
        "name": "string",
        "transferred_from_id": 0,
        "custom_attribute_values": [
          {
            "ca_config_id": 574,
            "section_ca_id": 1969,
            "value": "2025-05-22"
          }
        ],
        "system_attribute_values": [
          {
            "values": {
              "additionalProp1": {
                "id": 3165,
                "sa_id": 1,
                "value": "<p>test desc</p>"
              },
              "additionalProp2": {
                "id": 3165,
                "sa_id": 1,
                "value": "<p>test desc</p>"
              },
              "additionalProp3": {
                "id": 3165,
                "sa_id": 1,
                "value": "<p>test desc</p>"
              }
            }
          }
        ],
        "app_context": [
          {
            "container_id": 0,
            "container_source": "string",
            "container_type": "string"
          }
        ]
      }
    ]
  }
}

Schema definitions

{
  "rest_add_log": {
    "Data": [
      LogResponse
    ],
    "Failed": [
      {
        "failed_message": "reason for failure",
        LogResponse
      }
    ]
  }
}

Field	Type	Description
`Data`	Array of `Log`	List of successfully created logs.
`Failed`	Array	List of logs that failed to be added (usually with error messages).

LogResponse object

For more information, see API: Get Logs of a Workspace/Work.