Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Document

CloudObjects.update

Modifies CloudObject or CloudObjects with given id(s)

patch/entities/CloudObjects/{id}

Path parameters

idstring uuid required

ID of CloudObject to update

Query parameters

validation-levelinteger

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

application_idstring uuid

Id of the producing application.

company_cloud_object_folder_idstring uuid

Id of the company folder, or empty when the object is not stored in the company tree.

creator_idstring uuid

Id of the uploading user.

filenamestring

File name (with extension) used when downloading the object.

is_publicboolean

When true, the object can be served via a public URL (see public_url).

paramsobject

Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.

upload_source1 | 2

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

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "application_id": "01234567-abcd-dcba-ffff-000000000000",
  "company_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
  "creator_id": "01234567-abcd-dcba-ffff-000000000000",
  "filename": "string",
  "upload_source": 1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting CloudObject

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",
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "company_cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
    "creator_id": "01234567-abcd-dcba-ffff-000000000000",
    "filename": "string",
    "mime_type": "string",
    "size": 1,
    "type": -1,
    "upload_source": 1,
    "url": "string",
    "revision": 1,
    "duration": 4.32,
    "public_url": "string"
  }
}