COcoevera
Approval

ApprovalProcessActivityLogLines.batch_create_or_update

Creates or updates ApprovalProcessActivityLogLine records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/ApprovalProcessActivityLogLines/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

approval_idstring uuid

Id of the approval this log line belongs to.

dataobject

Typed JSON payload describing the approval step (e.g. approver decisions, comments).

executed_atstring date-time

Timestamp the step represented by this line was executed. Empty for scheduled steps that have not yet run.

is_visibleboolean

True when the line is shown in the activity log UI; false for internal-only lines.

sort_orderinteger

Position of the line within its approval run.

status1 | 2 | 3 | 4 | 5

Result of the approval step recorded by this line, such as Ok, Warning or Error.

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired

idstring uuid

ID of object to update.

Example request

[
  {
    "approval_id": "01234567-abcd-dcba-ffff-000000000000",
    "executed_at": "2019-01-01T00:00:00",
    "sort_order": 1,
    "status": 1
  }
]

Response

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.