v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Document

CloudObjectFolders.update

Modifies CloudObjectFolder or CloudObjectFolders with given id(s)

patch/entities/CloudObjectFolders/{id}

Path parameters

idstring uuid required

ID of CloudObjectFolder to update

Query parameters

validation-levelinteger

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

entity_api_namestring

API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.

namestring

Name of the entity and its default text representation.

online_form_type_idstring uuid

Id of the online form template, or empty when not associated with a form.

parent_cloud_object_folder_idstring uuid

Id of the parent folder, or empty for top-level folders.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "entity_api_name": "string",
  "name": "string",
  "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "parent_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting CloudObjectFolder

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",
    "entity_api_name": "string",
    "entity_type": 1,
    "name": "string",
    "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}