v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Form

FormViewSharingClientRelations.update

Modifies FormViewSharingClientRelation or FormViewSharingClientRelations with given id(s)

patch/entities/FormViewSharingClientRelations/{id}

Path parameters

idstring uuid required

ID of FormViewSharingClientRelation to update

Query parameters

validation-levelinteger

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

client_idstring uuid

Id of the user.

form_view_idstring uuid

Id of the shared form view.

role1 | 2

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

Integer enum value: 1 - Watcher, 2 - Editor

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "client_id": "01234567-abcd-dcba-ffff-000000000000",
  "form_view_id": "01234567-abcd-dcba-ffff-000000000000",
  "role": 1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting FormViewSharingClientRelation

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",
    "client_id": "01234567-abcd-dcba-ffff-000000000000",
    "form_view_id": "01234567-abcd-dcba-ffff-000000000000",
    "role": 1,
    "revision": 1
  }
}