CloudObjects.create - PipelinerCRM

Creates new CloudObject

Request

Query Params

validation-level

integer <int32>

optional

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

Body Params application / json

application_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

company_cloud_object_folder_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

creator_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

filename

string

required

Simple text input field.

Example:

string

is_public

boolean

optional

Boolean value.

Example:

false

params

object

optional

Field containing json.

upload_source

enum<integer>

optional

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

content

string <binary>

optional

Data content of the object.

Example:

blob

Example

{
    "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",
    "is_public": false,
    "params": {},
    "upload_source": 1,
    "revision": 1,
    "content": "blob"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created CloudObject

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (CloudObject)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

application

string <uri>

optional

Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.

company_cloud_object_folder

string <uri>

optional

Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties.

creator

string <uri>

optional

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

application_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

company_cloud_object_folder_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

creator_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

filename

string

required

Simple text input field.

Example:

string

is_public

boolean

optional

Boolean value.

Example:

false

mime_type

string

read-onlyoptional

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

Example:

string

params

object

optional

Field containing json.

size

integer <int32>

read-onlyrequired

Size of the object in bytes.

Example:

type

enum<integer>

read-onlyrequired

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

Allowed values:

-112345678910

Example:

-1

upload_source

enum<integer>

optional

Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor

Allowed values:

Example:

url

string

read-onlyoptional

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

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

dimensions

object

optional

returns dimensions in case of image

duration

number <double>

optional

returns duration of audio file in seconds

Example:

4.32

public_url

string

optional

returns public url for cloud object

Example:

string

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "application": "http://example.com",
        "company_cloud_object_folder": "http://example.com",
        "creator": "http://example.com",
        "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",
        "is_public": false,
        "mime_type": "string",
        "params": {},
        "size": 1,
        "type": -1,
        "upload_source": 1,
        "url": "string",
        "revision": 1,
        "dimensions": {},
        "duration": 4.32,
        "public_url": "string"
    }
}

🔴500Server Error