v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Online

OnlineFormActivityLogLines.update

Modifies OnlineFormActivityLogLine or OnlineFormActivityLogLines with given id(s)

patch/entities/OnlineFormActivityLogLines/{id}

Path parameters

idstring uuid required

ID of OnlineFormActivityLogLine to update

Query parameters

validation-levelinteger

Specify validation level of OnlineFormActivityLogLine on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

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.

online_form_idstring uuid

Id of the submission.

sort_orderinteger

Position of the line within its log run.

status1 | 2 | 3 | 4 | 5

Field whose values are strictly defined with an enumeration of values.

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

Example request

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

Response

Modification confirmation. Returns resulting OnlineFormActivityLogLine

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "formatted_text": "string",
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "executed_at": "2019-01-01T00:00:00",
    "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "status": 1
  }
}