COcoevera
Document

CloudObjectFolders.update

Changes fields of the CloudObjectFolder record with the given id; fields left out keep their values.

patch/entities/CloudObjectFolders/{id}

Request

Path parameters

idstring uuid required

Id of the CloudObjectFolder record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

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

The changed CloudObjectFolder record.

successboolean

True when the request 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
  }
}

Changes

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