COcoevera
Document

CloudObjects.create

Creates a CloudObject record.

post/entities/CloudObjects

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.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

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 required

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).

mime_typestring

Mime-type of the cloud object Is detected from content.

paramsobject

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

type-1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 required

Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only.

Integer enum value: -1 - S3FileUpload, 1 - S3File, 2 - S3Image, 3 - GoogleDriveFile, 4 - OneDriveFile, 5 - BoxFile, 6 - DropboxFile, 7 - SharepointFile, 8 - ExternalURL, 9 - AlfrescoFile, 10 - UrlFile

upload_source1 | 2

Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

urlstring

URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.

revisioninteger

Revision when entity was lastly changed.

contentstring binary

Data content of the object.

Example request

{
  "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",
  "type": -1,
  "upload_source": 1,
  "url": "string",
  "revision": 1,
  "content": "blob"
}

Response

The created CloudObject 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",
    "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"
  }
}

Changes

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