Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Document

CloudObjectStepRelations.update

Modifies CloudObjectStepRelation or CloudObjectStepRelations with given id(s)

patch/entities/CloudObjectStepRelations/{id}

Path parameters

idstring uuid required

ID of CloudObjectStepRelation to update

Query parameters

validation-levelinteger

Specify validation level of CloudObjectStepRelation 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

cloud_object_idstring uuid

Id of the attached file.

sort_orderinteger

Position of the file within the step's document list.

step_idstring uuid

Id of the pipeline step.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
  "sort_order": 1,
  "step_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting CloudObjectStepRelation

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}