Sign in
Action

Update a link action

Updates a link action

patch/link/{linkId}/action/{id}

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

linkIdstring uuid required

Unique identifier for the entity represented as a UUID

Request body

desired_specification_idstring uuid

Unique identifier for the entity represented as a UUID

status'pending_create' | 'pending' | 'in_progress' | 'success' | 'failed' | 'cancelled'

Status of the action. Should be one of the specified values in the ActionStatus enumeration

parametersobject

Parameters associated with the action

resultsobject

Results produced by the action

Response

Object representing instances

idstring uuid

Unique identifier for the entity represented as a UUID

specification_idstring uuid

Unique identifier for the entity represented as a UUID

desired_specification_idstring uuid

Unique identifier for the entity represented as a UUID

created_atstring date
updated_atstring date
status'pending_create' | 'pending' | 'in_progress' | 'success' | 'failed' | 'cancelled'

Status of the action. Should be one of the specified values in the ActionStatus enumeration

parametersobject

Parameters associated with the action

resultsobject

Results produced by the action

service_idstring uuid

Unique identifier for the entity represented as a UUID

link_idstring uuid

Unique identifier for the entity represented as a UUID

created_bystring

User ID of the user who created the action

Changes

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