COcoevera
Document

CloudObjectFolders.batch_create_or_update

Creates or updates CloudObjectFolder records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/CloudObjectFolders/batch-modify

Request

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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