openapi: 3.2.0 info: title: Pipeliner Cloud Document API version: '100' servers: - url: https://us-east.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://eu-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ca-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ap-southeast.api.pipelinersales.com/api/v100/rest/spaces/{space_id} tags: - name: Document paths: /entities/CloudObjects/{id}: get: description: Returns CloudObject with given id operationId: CloudObjects.get summary: CloudObjects.get tags: - Document parameters: - name: id in: path description: ID of CloudObject to retrieve required: true schema: type: string format: uuid responses: '200': description: CloudObject data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObject' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes CloudObject with given id operationId: CloudObjects.delete summary: CloudObjects.delete tags: - Document parameters: - name: id in: path description: ID of CloudObject to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObject on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted CloudObject type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies CloudObject or CloudObjects with given id(s) parameters: - name: id in: path description: ID of CloudObject to update required: true schema: type: string format: uuid - name: validation-level in: query description: '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.' schema: type: integer format: int32 operationId: CloudObjects.update summary: CloudObjects.update tags: - Document requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectInput' responses: '200': description: Modification confirmation. Returns resulting CloudObject content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObject' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjects: get: description: Returns all defined CloudObjects operationId: CloudObjects.list summary: CloudObjects.list tags: - Document parameters: - name: include-deleted in: query description: if enabled, deleted CloudObjects are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjects content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/CloudObject' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new CloudObject operationId: CloudObjects.create summary: CloudObjects.create tags: - Document parameters: - name: validation-level in: query description: '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.' schema: type: integer format: int32 requestBody: description: data of new CloudObject required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectInput' responses: '201': description: Creation confirmation. Returns created CloudObject content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObject' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjects/batch-delete: post: description: Removes CloudObjects with given list of ids operationId: CloudObjects.batch_delete summary: CloudObjects.batch_delete tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjects on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObject to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted CloudObject. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjects/batch-modify: post: description: Create or update an batch of CloudObjects operationId: CloudObjects.batch_create_or_update summary: CloudObjects.batch_create_or_update tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjects on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new CloudObject required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchCloudObjectInput' responses: '200': description: Creation confirmation. Returns a list of created / updated CloudObjects content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjects/batch-restore: post: description: Restores CloudObjects with given list of ids operationId: CloudObjects.batch_restore summary: CloudObjects.batch_restore tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjects on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjects. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObject to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored CloudObject. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectFolders/{id}: get: description: Returns CloudObjectFolder with given id operationId: CloudObjectFolders.get summary: CloudObjectFolders.get tags: - Document parameters: - name: id in: path description: ID of CloudObjectFolder to retrieve required: true schema: type: string format: uuid responses: '200': description: CloudObjectFolder data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectFolder' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes CloudObjectFolder with given id operationId: CloudObjectFolders.delete summary: CloudObjectFolders.delete tags: - Document parameters: - name: id in: path description: ID of CloudObjectFolder to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectFolder on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted CloudObjectFolder type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies CloudObjectFolder or CloudObjectFolders with given id(s) parameters: - name: id in: path description: ID of CloudObjectFolder to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectFolder 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.' schema: type: integer format: int32 operationId: CloudObjectFolders.update summary: CloudObjectFolders.update tags: - Document requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectFolderInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectFolder content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectFolder' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectFolders: get: description: Returns all defined CloudObjectFolders operationId: CloudObjectFolders.list summary: CloudObjectFolders.list tags: - Document parameters: - name: include-deleted in: query description: if enabled, deleted CloudObjectFolders are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectFolders content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/CloudObjectFolder' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new CloudObjectFolder operationId: CloudObjectFolders.create summary: CloudObjectFolders.create tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectFolder 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.' schema: type: integer format: int32 requestBody: description: data of new CloudObjectFolder required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectFolderInput' responses: '201': description: Creation confirmation. Returns created CloudObjectFolder content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectFolder' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectFolders/batch-delete: post: description: Removes CloudObjectFolders with given list of ids operationId: CloudObjectFolders.batch_delete summary: CloudObjectFolders.batch_delete tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectFolders on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectFolder to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted CloudObjectFolder. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectFolders/batch-modify: post: description: Create or update an batch of CloudObjectFolders operationId: CloudObjectFolders.batch_create_or_update summary: CloudObjectFolders.batch_create_or_update tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectFolders on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new CloudObjectFolder required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchCloudObjectFolderInput' responses: '200': description: Creation confirmation. Returns a list of created / updated CloudObjectFolders content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectFolders/batch-restore: post: description: Restores CloudObjectFolders with given list of ids operationId: CloudObjectFolders.batch_restore summary: CloudObjectFolders.batch_restore tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectFolders on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectFolders. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectFolder to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored CloudObjectFolder. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectRelations/{id}: get: description: Returns CloudObjectRelation with given id operationId: CloudObjectRelations.get summary: CloudObjectRelations.get tags: - Document parameters: - name: id in: path description: ID of CloudObjectRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: CloudObjectRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes CloudObjectRelation with given id operationId: CloudObjectRelations.delete summary: CloudObjectRelations.delete tags: - Document parameters: - name: id in: path description: ID of CloudObjectRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectRelation on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted CloudObjectRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies CloudObjectRelation or CloudObjectRelations with given id(s) parameters: - name: id in: path description: ID of CloudObjectRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectRelation 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.' schema: type: integer format: int32 operationId: CloudObjectRelations.update summary: CloudObjectRelations.update tags: - Document requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectRelationInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectRelations: get: description: Returns all defined CloudObjectRelations operationId: CloudObjectRelations.list summary: CloudObjectRelations.list tags: - Document parameters: - name: include-deleted in: query description: if enabled, deleted CloudObjectRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/CloudObjectRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new CloudObjectRelation operationId: CloudObjectRelations.create summary: CloudObjectRelations.create tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectRelation 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.' schema: type: integer format: int32 requestBody: description: data of new CloudObjectRelation required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectRelationInput' responses: '201': description: Creation confirmation. Returns created CloudObjectRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectRelations/batch-delete: post: description: Removes CloudObjectRelations with given list of ids operationId: CloudObjectRelations.batch_delete summary: CloudObjectRelations.batch_delete tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectRelations on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted CloudObjectRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectRelations/batch-modify: post: description: Create or update an batch of CloudObjectRelations operationId: CloudObjectRelations.batch_create_or_update summary: CloudObjectRelations.batch_create_or_update tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectRelations on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new CloudObjectRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchCloudObjectRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated CloudObjectRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectRelations/batch-restore: post: description: Restores CloudObjectRelations with given list of ids operationId: CloudObjectRelations.batch_restore summary: CloudObjectRelations.batch_restore tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectRelations on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored CloudObjectRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectStepRelations/{id}: get: description: Returns CloudObjectStepRelation with given id operationId: CloudObjectStepRelations.get summary: CloudObjectStepRelations.get tags: - Document parameters: - name: id in: path description: ID of CloudObjectStepRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: CloudObjectStepRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectStepRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes CloudObjectStepRelation with given id operationId: CloudObjectStepRelations.delete summary: CloudObjectStepRelations.delete tags: - Document parameters: - name: id in: path description: ID of CloudObjectStepRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectStepRelation on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted CloudObjectStepRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies CloudObjectStepRelation or CloudObjectStepRelations with given id(s) parameters: - name: id in: path description: ID of CloudObjectStepRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectStepRelation 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.' schema: type: integer format: int32 operationId: CloudObjectStepRelations.update summary: CloudObjectStepRelations.update tags: - Document requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectStepRelationInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectStepRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectStepRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectStepRelations: get: description: Returns all defined CloudObjectStepRelations operationId: CloudObjectStepRelations.list summary: CloudObjectStepRelations.list tags: - Document parameters: - name: include-deleted in: query description: if enabled, deleted CloudObjectStepRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectStepRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/CloudObjectStepRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new CloudObjectStepRelation operationId: CloudObjectStepRelations.create summary: CloudObjectStepRelations.create tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectStepRelation 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.' schema: type: integer format: int32 requestBody: description: data of new CloudObjectStepRelation required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectStepRelationInput' responses: '201': description: Creation confirmation. Returns created CloudObjectStepRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectStepRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectStepRelations/batch-delete: post: description: Removes CloudObjectStepRelations with given list of ids operationId: CloudObjectStepRelations.batch_delete summary: CloudObjectStepRelations.batch_delete tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectStepRelations on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectStepRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted CloudObjectStepRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectStepRelations/batch-modify: post: description: Create or update an batch of CloudObjectStepRelations operationId: CloudObjectStepRelations.batch_create_or_update summary: CloudObjectStepRelations.batch_create_or_update tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectStepRelations on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new CloudObjectStepRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchCloudObjectStepRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated CloudObjectStepRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectStepRelations/batch-restore: post: description: Restores CloudObjectStepRelations with given list of ids operationId: CloudObjectStepRelations.batch_restore summary: CloudObjectStepRelations.batch_restore tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectStepRelations on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectStepRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectStepRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored CloudObjectStepRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectTemplates/{id}: get: description: Returns CloudObjectTemplate with given id operationId: CloudObjectTemplates.get summary: CloudObjectTemplates.get tags: - Document parameters: - name: id in: path description: ID of CloudObjectTemplate to retrieve required: true schema: type: string format: uuid responses: '200': description: CloudObjectTemplate data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectTemplate' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes CloudObjectTemplate with given id operationId: CloudObjectTemplates.delete summary: CloudObjectTemplates.delete tags: - Document parameters: - name: id in: path description: ID of CloudObjectTemplate to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectTemplate on delete. 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.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted CloudObjectTemplate type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies CloudObjectTemplate or CloudObjectTemplates with given id(s) parameters: - name: id in: path description: ID of CloudObjectTemplate to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of CloudObjectTemplate 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.' schema: type: integer format: int32 operationId: CloudObjectTemplates.update summary: CloudObjectTemplates.update tags: - Document requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateCloudObjectTemplateInput' responses: '200': description: Modification confirmation. Returns resulting CloudObjectTemplate content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectTemplate' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectTemplates: get: description: Returns all defined CloudObjectTemplates operationId: CloudObjectTemplates.list summary: CloudObjectTemplates.list tags: - Document parameters: - name: include-deleted in: query description: if enabled, deleted CloudObjectTemplates are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of CloudObjectTemplates content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/CloudObjectTemplate' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new CloudObjectTemplate operationId: CloudObjectTemplates.create summary: CloudObjectTemplates.create tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectTemplate 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.' schema: type: integer format: int32 requestBody: description: data of new CloudObjectTemplate required: true content: application / json: schema: $ref: '#/components/schemas/createCloudObjectTemplateInput' responses: '201': description: Creation confirmation. Returns created CloudObjectTemplate content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/CloudObjectTemplate' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectTemplates/batch-delete: post: description: Removes CloudObjectTemplates with given list of ids operationId: CloudObjectTemplates.batch_delete summary: CloudObjectTemplates.batch_delete tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectTemplates on delete. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectTemplate to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted CloudObjectTemplate. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectTemplates/batch-modify: post: description: Create or update an batch of CloudObjectTemplates operationId: CloudObjectTemplates.batch_create_or_update summary: CloudObjectTemplates.batch_create_or_update tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectTemplates on change. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new CloudObjectTemplate required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchCloudObjectTemplateInput' responses: '200': description: Creation confirmation. Returns a list of created / updated CloudObjectTemplates content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/CloudObjectTemplates/batch-restore: post: description: Restores CloudObjectTemplates with given list of ids operationId: CloudObjectTemplates.batch_restore summary: CloudObjectTemplates.batch_restore tags: - Document parameters: - name: validation-level in: query description: 'Specify validation level of CloudObjectTemplates on restore. 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.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for CloudObjectTemplates. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity CloudObjectTemplate to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored CloudObjectTemplate. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: createCloudObjectFolderInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true entity_api_name: type: string example: string description: API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 name: type: string example: string description: Name of the entity and its default text representation. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form template, or empty when not associated with a form. parent_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder, or empty for top-level folders. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - name createCloudObjectRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cloud_object: type: object properties: id: type: string format: uri description: 'Cloud object (file) being linked. Relation to CloudObject, see: ''createCloudObjectInput'' object for properties.' report_schedule: type: object properties: id: type: string format: uri description: 'Report schedule the file is attached to (e.g. an exported report). Relation to ReportSchedule, see: ''createReportScheduleInput'' object for properties.' text_message: type: object properties: id: type: string format: uri description: 'Text message (SMS/MMS) the file is attached to. Relation to TextMessage, see: ''createTextMessageInput'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked appointment or task, or empty when not linked. approval_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked approval process. call_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked call. cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder within the parent record, or empty when stored at the record root. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked file. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_sequence_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email sequence. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email template. field_mapping_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked field mapping. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. media_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked media record. message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email or memo, or empty when not linked. online_form_field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form field the file was uploaded into. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked online form submission. process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process. process_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process template. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. report_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked report schedule. text_message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked text message. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. Error: properties: http_status: description: HTTP status code type: integer example: 400 code: description: Internal API error code type: integer example: 117 name: description: Name of the API error type: string example: ERROR_PARAMETER_INVALID message: description: Description of the API error type: string success: description: Always false on error. type: boolean example: false required: - success - http_status createCloudObjectStepRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cloud_object: type: object properties: id: type: string format: uri description: 'File attached to the step. Relation to CloudObject, see: ''createCloudObjectInput'' object for properties.' cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the attached file. sort_order: type: integer format: int32 example: 1 description: Position of the file within the step's document list. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - cloud_object - step_id CloudObjectTemplate: properties: is_delete_protected: type: boolean example: false description: 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. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true application: type: string format: uri description: 'Application that produced the object (e.g. Online Forms). 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: type: string format: uri description: 'Company-level folder that contains the object, when stored in the company document tree. 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: type: string format: uri description: 'User who uploaded the object. 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: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). mime_type: type: string example: string description: Mime-type of the cloud object Is detected from content. readOnly: true size: type: integer format: int32 example: 1 description: Size of the object in bytes. readOnly: true status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Active, 2 - Inactive' example: 1 enum: - 1 - 2 template_entity_name: type: string example: Account enum: - Account - AccountDataExRelation - AccountKPI - AccountProductPricing - AccountRole - AccountSharingClientRelation - AccountSharingSalesUnitRelation - AccountSocialRelation - AccountType - Activity - ActivityComment - ActivityDataExRelation - ActivityDetail - ActivityKPI - ActivityRelation - ActivityType - AiAgent - AiBalance - AiEvent - AiEventJournal - AllowedAccountType - AllowedCompanyPhone - AllowedContactType - AllowedLeadType - AllowedPipeline - AllowedQuoteType - ApiAccess - Application - Appointment - AppointmentClientInviteesRelation - AppointmentContactInviteesRelation - AppointmentInviteeNotifyQueue - AppointmentReminder - AppointmentSchedule - AppointmentType - Approval - ApprovalApprover - ApprovalProcess - ApprovalProcessActivityLogLine - AuditLog - AutomationHubApp - AutomationHubCategory - AutomationHubItem - ChatConversation - Client - ClientExcludedOppty - ClientFavorite - ClientSetting - ClientStoryRead - CloudObject - CloudObjectFolder - CloudObjectRelation - CloudObjectStepRelation - CloudObjectTemplate - CompanyEmail - Contact - ContactAccountAccountRoleRelation - ContactAccountRelation - ContactDataExRelation - ContactKPI - ContactRelation - ContactRelationType - ContactSharingClientRelation - ContactSharingSalesUnitRelation - ContactSocialRelation - ContactType - Country - CountryCrm - CpActivity - CpCallLog - CpCalling - CpClient - CpProduct - CpProfile - CpTeamSpaceClient - Currency - CurrencyExchangeRate - CurrencyExchangeRatesList - CustomEntity - CustomEntityDataExRelation - CustomEntityKPI - CustomEntityRelation - CustomEntityRelationData - CustomEntitySharingClientRelation - CustomEntitySharingSalesUnitRelation - CustomEntityType - Data - Ebook - Email - EmailContentSharingClientRelation - EmailContentSharingSalesUnitRelation - EmailMailboxRelation - EmailSequence - EmailSequenceActivityLog - EmailSequenceActivityLogLine - EmailSequenceEnrolled - EmailSequenceEnrolledStatus - EmailSequenceSettings - EmailTemplate - EmailTemplateFolder - EmailTemplateSharingClientRelation - EmailTemplateSharingSalesUnitRelation - EmailThreadMailboxClientReadState - Entity - EntityFitness - EntityFitnessIndicator - EntityHealth - EntityHealthSettingsHistory - EntityScoring - EntitySettings - EntityType - Field - FieldMapping - FieldPermission - FieldSequence - Forecast - ForecastSharingClientRelation - ForecastSharingSalesUnitRelation - FormView - FormViewSharingClientRelation - FormViewSharingSalesUnitRelation - GhostContact - GhostContactAccountAccountRoleRelation - GhostContactAccountRelation - GhostLeadOpptyContactRelation - GhostLeadOpptyContactSalesRoleRelation - HowTo - ImportMappingMask - InterfacePreview - Lead - LeadOppty - LeadOpptyAccountRelation - LeadOpptyContactGroupRelation - LeadOpptyContactRelation - LeadOpptyContactSalesRoleRelation - LeadOpptyDataExRelation - LeadOpptyKPI - LeadOpptyProjectRelation - LeadOpptySharingClientRelation - LeadOpptySharingSalesUnitRelation - LeadOpptyStepCheckListRelation - LeadOpptyType - LeadProcess - LeadType - MasterRight - Media - Memo - MemoComment - Message - MessageRelation - MessageSharingClientRelation - MessageSharingSalesUnitRelation - Note - NotificationSetting - OnlineForm - OnlineFormActivityLogLine - OnlineFormDataExRelation - OnlineFormRelation - OnlineFormStyle - OnlineFormType - OnlineFormTypeEmailRelation - Opportunity - OpportunityType - OpptyProductRelation - OpptyProductRelationDataExRelation - OpptyProductRelationRevenueSchedule - OpptyProductRelationRevenueSchedulePeriod - OpptyProductRelationType - OpptyRecurrence - OpptyRevenueSchedule - OpptyRevenueSchedulePeriod - Order - OrderHistory - OrderItem - OrderRelatedDocument - OrderTempData - OrderTempDataItem - ParentAccountRelationType - Partner - Payment - PaymentAdditionalData - PaymentTerm - Phone - Pipeline - Process - ProcessActivityLog - ProcessActivityLogLine - ProcessChangeOwnerLog - ProcessScheduledAction - ProcessTemplate - Product - ProductCategory - ProductDataExRelation - ProductPipelineRelation - ProductPriceList - ProductPriceListPrice - ProductType - Profile - ProfileDraft - ProfileRelation - ProfileSharingClientRelation - ProfileSharingSalesUnitRelation - Project - ProjectContactRelation - ProjectDataExRelation - ProjectKPI - ProjectObjective - ProjectSharingClientRelation - ProjectSharingSalesUnitRelation - ProjectType - PurchasedProduct - Quote - QuoteAccountRelation - QuoteContactRelation - QuoteDataExRelation - QuoteKPI - QuoteProcess - QuoteSharingClientRelation - QuoteSharingSalesUnitRelation - QuoteType - ReleaseNote - Report - ReportFolder - ReportSchedule - ReportSharingClientRelation - ReportSharingSalesUnitRelation - RevenueRecognition - SalesRole - SalesUnit - SalesUnitClientRelation - SapiUser - SpaceSetting - State - Step - StepChecklist - StepChecklistSalesRoleRelation - Storylane - Subscription - SubscriptionHubItem - SubscriptionNotification - SubscriptionRepresentative - SubscriptionSDR - Supplier - Tag - TagRelation - Target - TargetRelation - Task - TaskRecurrence - TaskReminder - TaskSharingClientRelation - TaskSharingSalesUnitRelation - TaskType - TeamPipelineHubItem - TeamPipelineHubItemBase - TeamSpace - TeamSpaceClient - TeamSpaceClientSetting - TeamSpaceProperty - TeamSpaceRegion - TextMessage - TextMessageConversation - TextMessageConversationRelations - Timeframe - Translation - Type - UnsubscribedPhone - UseCase - UserProfile - UserRole - Webhook - WebhookEvent - Webresource description: Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via template_entity_api_name. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. 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' example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 url: type: string example: string description: URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. template_entity_api_name: type: string example: string description: API name of the custom entity the template renders. Set only when template_entity_name is "CustomEntity"; otherwise empty. required: - is_delete_protected - id - filename - size - template_entity_name - type CloudObjectStepRelation: properties: is_delete_protected: type: boolean example: false description: 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. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true cloud_object: type: string format: uri description: 'File attached to the step. Relation to CloudObject. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObject'' object for properties.' step: type: string format: uri description: 'Pipeline step the file is attached to. Relation to Step. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Step'' object for properties.' cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the attached file. sort_order: type: integer format: int32 example: 1 description: Position of the file within the step's document list. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - cloud_object - step - step_id updateCloudObjectStepRelationInput: properties: cloud_object: type: object properties: id: type: string format: uri description: 'File attached to the step. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the attached file. sort_order: type: integer format: int32 example: 1 description: Position of the file within the step's document list. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. CloudObject: properties: is_delete_protected: type: boolean example: false description: 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. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true application: type: string format: uri description: 'Application that produced the object (e.g. Online Forms). 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: type: string format: uri description: 'Company-level folder that contains the object, when stored in the company document tree. 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: type: string format: uri description: 'User who uploaded the object. 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: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). mime_type: type: string example: string description: Mime-type of the cloud object Is detected from content. readOnly: true params: type: object description: Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. size: type: integer format: int32 example: 1 description: Size of the object in bytes. readOnly: true type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. 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' example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 url: type: string example: string description: URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. dimensions: type: object description: returns dimensions in case of image duration: type: number format: double example: 4.32 description: returns duration of audio file in seconds public_url: type: string example: string description: returns public url for cloud object required: - is_delete_protected - id - filename - size - type CloudObjectRelation: properties: is_delete_protected: type: boolean example: false description: 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. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account the file is attached to, or empty when not attached to an account. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' appointment: type: string format: uri description: 'Appointment the file is attached to. Set when activity_id resolves to an Appointment. Relation to Appointment. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Appointment'' object for properties.' task: type: string format: uri description: 'Task the file is attached to. Set when activity_id resolves to a Task. Relation to Task. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Task'' object for properties.' approval_process: type: string format: uri description: 'Approval process the file is attached to. Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ApprovalProcess'' object for properties.' call: type: string format: uri description: 'Call the file is attached to (e.g. a call recording). Relation to Call. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Call'' object for properties.' cloud_object_folder: type: string format: uri description: 'Folder the file is filed under within the parent record, or empty when stored at the record root. 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.' cloud_object: type: string format: uri description: 'Cloud object (file) being linked. Relation to CloudObject. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObject'' object for properties.' contact: type: string format: uri description: 'Contact the file is attached to, or empty when not attached to a contact. Relation to Contact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Contact'' object for properties.' custom_entity: type: string format: uri description: 'Custom entity record the file is attached to. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CustomEntity'' object for properties.' email_sequence: type: string format: uri description: 'Email sequence the file is attached to. Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailSequence'' object for properties.' email_template: type: string format: uri description: 'Email template the file is attached to as a template attachment. Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''EmailTemplate'' object for properties.' field_mapping: type: string format: uri description: 'Field mapping the file is attached to (e.g. an import file). Relation to FieldMapping. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''FieldMapping'' object for properties.' lead: type: string format: uri description: 'Lead the file is attached to. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Lead'' object for properties.' oppty: type: string format: uri description: 'Opportunity the file is attached to. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' media: type: string format: uri description: 'Media record the file is attached to. Relation to Media. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Media'' object for properties.' email: type: string format: uri description: 'Email the file is attached to (e.g. an email attachment). Set when message_id resolves to an Email. Relation to Email. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Email'' object for properties.' memo: type: string format: uri description: 'Memo the file is attached to. Set when message_id resolves to a Memo. Relation to Memo. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Memo'' object for properties.' online_form_field: type: string format: uri description: 'Online form field the file was uploaded into. Relation to Field. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Field'' object for properties.' online_form: type: string format: uri description: 'Online form submission the file was uploaded with. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineForm'' object for properties.' process: type: string format: uri description: 'Sales process the file is attached to. Relation to Process. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Process'' object for properties.' process_template: type: string format: uri description: 'Sales process template the file is attached to. Relation to ProcessTemplate. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProcessTemplate'' object for properties.' project: type: string format: uri description: 'Project the file is attached to. Relation to Project. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Project'' object for properties.' quote: type: string format: uri description: 'Quote the file is attached to. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' report_schedule: type: string format: uri description: 'Report schedule the file is attached to (e.g. an exported report). Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ReportSchedule'' object for properties.' text_message: type: string format: uri description: 'Text message (SMS/MMS) the file is attached to. Relation to TextMessage. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''TextMessage'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked appointment or task, or empty when not linked. approval_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked approval process. call_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked call. cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder within the parent record, or empty when stored at the record root. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked file. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_sequence_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email sequence. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email template. field_mapping_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked field mapping. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. media_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked media record. message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email or memo, or empty when not linked. online_form_field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form field the file was uploaded into. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked online form submission. process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process. process_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process template. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. report_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked report schedule. text_message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked text message. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id batchCloudObjectTemplateInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Active, 2 - Inactive' example: 1 enum: - 1 - 2 template_entity_name: type: string example: Account enum: - Account - AccountDataExRelation - AccountKPI - AccountProductPricing - AccountRole - AccountSharingClientRelation - AccountSharingSalesUnitRelation - AccountSocialRelation - AccountType - Activity - ActivityComment - ActivityDataExRelation - ActivityDetail - ActivityKPI - ActivityRelation - ActivityType - AiAgent - AiBalance - AiEvent - AiEventJournal - AllowedAccountType - AllowedCompanyPhone - AllowedContactType - AllowedLeadType - AllowedPipeline - AllowedQuoteType - ApiAccess - Application - Appointment - AppointmentClientInviteesRelation - AppointmentContactInviteesRelation - AppointmentInviteeNotifyQueue - AppointmentReminder - AppointmentSchedule - AppointmentType - Approval - ApprovalApprover - ApprovalProcess - ApprovalProcessActivityLogLine - AuditLog - AutomationHubApp - AutomationHubCategory - AutomationHubItem - ChatConversation - Client - ClientExcludedOppty - ClientFavorite - ClientSetting - ClientStoryRead - CloudObject - CloudObjectFolder - CloudObjectRelation - CloudObjectStepRelation - CloudObjectTemplate - CompanyEmail - Contact - ContactAccountAccountRoleRelation - ContactAccountRelation - ContactDataExRelation - ContactKPI - ContactRelation - ContactRelationType - ContactSharingClientRelation - ContactSharingSalesUnitRelation - ContactSocialRelation - ContactType - Country - CountryCrm - CpActivity - CpCallLog - CpCalling - CpClient - CpProduct - CpProfile - CpTeamSpaceClient - Currency - CurrencyExchangeRate - CurrencyExchangeRatesList - CustomEntity - CustomEntityDataExRelation - CustomEntityKPI - CustomEntityRelation - CustomEntityRelationData - CustomEntitySharingClientRelation - CustomEntitySharingSalesUnitRelation - CustomEntityType - Data - Ebook - Email - EmailContentSharingClientRelation - EmailContentSharingSalesUnitRelation - EmailMailboxRelation - EmailSequence - EmailSequenceActivityLog - EmailSequenceActivityLogLine - EmailSequenceEnrolled - EmailSequenceEnrolledStatus - EmailSequenceSettings - EmailTemplate - EmailTemplateFolder - EmailTemplateSharingClientRelation - EmailTemplateSharingSalesUnitRelation - EmailThreadMailboxClientReadState - Entity - EntityFitness - EntityFitnessIndicator - EntityHealth - EntityHealthSettingsHistory - EntityScoring - EntitySettings - EntityType - Field - FieldMapping - FieldPermission - FieldSequence - Forecast - ForecastSharingClientRelation - ForecastSharingSalesUnitRelation - FormView - FormViewSharingClientRelation - FormViewSharingSalesUnitRelation - GhostContact - GhostContactAccountAccountRoleRelation - GhostContactAccountRelation - GhostLeadOpptyContactRelation - GhostLeadOpptyContactSalesRoleRelation - HowTo - ImportMappingMask - InterfacePreview - Lead - LeadOppty - LeadOpptyAccountRelation - LeadOpptyContactGroupRelation - LeadOpptyContactRelation - LeadOpptyContactSalesRoleRelation - LeadOpptyDataExRelation - LeadOpptyKPI - LeadOpptyProjectRelation - LeadOpptySharingClientRelation - LeadOpptySharingSalesUnitRelation - LeadOpptyStepCheckListRelation - LeadOpptyType - LeadProcess - LeadType - MasterRight - Media - Memo - MemoComment - Message - MessageRelation - MessageSharingClientRelation - MessageSharingSalesUnitRelation - Note - NotificationSetting - OnlineForm - OnlineFormActivityLogLine - OnlineFormDataExRelation - OnlineFormRelation - OnlineFormStyle - OnlineFormType - OnlineFormTypeEmailRelation - Opportunity - OpportunityType - OpptyProductRelation - OpptyProductRelationDataExRelation - OpptyProductRelationRevenueSchedule - OpptyProductRelationRevenueSchedulePeriod - OpptyProductRelationType - OpptyRecurrence - OpptyRevenueSchedule - OpptyRevenueSchedulePeriod - Order - OrderHistory - OrderItem - OrderRelatedDocument - OrderTempData - OrderTempDataItem - ParentAccountRelationType - Partner - Payment - PaymentAdditionalData - PaymentTerm - Phone - Pipeline - Process - ProcessActivityLog - ProcessActivityLogLine - ProcessChangeOwnerLog - ProcessScheduledAction - ProcessTemplate - Product - ProductCategory - ProductDataExRelation - ProductPipelineRelation - ProductPriceList - ProductPriceListPrice - ProductType - Profile - ProfileDraft - ProfileRelation - ProfileSharingClientRelation - ProfileSharingSalesUnitRelation - Project - ProjectContactRelation - ProjectDataExRelation - ProjectKPI - ProjectObjective - ProjectSharingClientRelation - ProjectSharingSalesUnitRelation - ProjectType - PurchasedProduct - Quote - QuoteAccountRelation - QuoteContactRelation - QuoteDataExRelation - QuoteKPI - QuoteProcess - QuoteSharingClientRelation - QuoteSharingSalesUnitRelation - QuoteType - ReleaseNote - Report - ReportFolder - ReportSchedule - ReportSharingClientRelation - ReportSharingSalesUnitRelation - RevenueRecognition - SalesRole - SalesUnit - SalesUnitClientRelation - SapiUser - SpaceSetting - State - Step - StepChecklist - StepChecklistSalesRoleRelation - Storylane - Subscription - SubscriptionHubItem - SubscriptionNotification - SubscriptionRepresentative - SubscriptionSDR - Supplier - Tag - TagRelation - Target - TargetRelation - Task - TaskRecurrence - TaskReminder - TaskSharingClientRelation - TaskSharingSalesUnitRelation - TaskType - TeamPipelineHubItem - TeamPipelineHubItemBase - TeamSpace - TeamSpaceClient - TeamSpaceClientSetting - TeamSpaceProperty - TeamSpaceRegion - TextMessage - TextMessageConversation - TextMessageConversationRelations - Timeframe - Translation - Type - UnsubscribedPhone - UseCase - UserProfile - UserRole - Webhook - WebhookEvent - Webresource description: Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via template_entity_api_name. upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. content: type: string format: binary example: blob description: Data content of the object. template_entity_api_name: type: string example: string description: API name of the custom entity the template renders. Set only when template_entity_name is "CustomEntity"; otherwise empty. id: description: ID of object to update. type: string format: uuid createCloudObjectTemplateInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Active, 2 - Inactive' example: 1 enum: - 1 - 2 template_entity_name: type: string example: Account enum: - Account - AccountDataExRelation - AccountKPI - AccountProductPricing - AccountRole - AccountSharingClientRelation - AccountSharingSalesUnitRelation - AccountSocialRelation - AccountType - Activity - ActivityComment - ActivityDataExRelation - ActivityDetail - ActivityKPI - ActivityRelation - ActivityType - AiAgent - AiBalance - AiEvent - AiEventJournal - AllowedAccountType - AllowedCompanyPhone - AllowedContactType - AllowedLeadType - AllowedPipeline - AllowedQuoteType - ApiAccess - Application - Appointment - AppointmentClientInviteesRelation - AppointmentContactInviteesRelation - AppointmentInviteeNotifyQueue - AppointmentReminder - AppointmentSchedule - AppointmentType - Approval - ApprovalApprover - ApprovalProcess - ApprovalProcessActivityLogLine - AuditLog - AutomationHubApp - AutomationHubCategory - AutomationHubItem - ChatConversation - Client - ClientExcludedOppty - ClientFavorite - ClientSetting - ClientStoryRead - CloudObject - CloudObjectFolder - CloudObjectRelation - CloudObjectStepRelation - CloudObjectTemplate - CompanyEmail - Contact - ContactAccountAccountRoleRelation - ContactAccountRelation - ContactDataExRelation - ContactKPI - ContactRelation - ContactRelationType - ContactSharingClientRelation - ContactSharingSalesUnitRelation - ContactSocialRelation - ContactType - Country - CountryCrm - CpActivity - CpCallLog - CpCalling - CpClient - CpProduct - CpProfile - CpTeamSpaceClient - Currency - CurrencyExchangeRate - CurrencyExchangeRatesList - CustomEntity - CustomEntityDataExRelation - CustomEntityKPI - CustomEntityRelation - CustomEntityRelationData - CustomEntitySharingClientRelation - CustomEntitySharingSalesUnitRelation - CustomEntityType - Data - Ebook - Email - EmailContentSharingClientRelation - EmailContentSharingSalesUnitRelation - EmailMailboxRelation - EmailSequence - EmailSequenceActivityLog - EmailSequenceActivityLogLine - EmailSequenceEnrolled - EmailSequenceEnrolledStatus - EmailSequenceSettings - EmailTemplate - EmailTemplateFolder - EmailTemplateSharingClientRelation - EmailTemplateSharingSalesUnitRelation - EmailThreadMailboxClientReadState - Entity - EntityFitness - EntityFitnessIndicator - EntityHealth - EntityHealthSettingsHistory - EntityScoring - EntitySettings - EntityType - Field - FieldMapping - FieldPermission - FieldSequence - Forecast - ForecastSharingClientRelation - ForecastSharingSalesUnitRelation - FormView - FormViewSharingClientRelation - FormViewSharingSalesUnitRelation - GhostContact - GhostContactAccountAccountRoleRelation - GhostContactAccountRelation - GhostLeadOpptyContactRelation - GhostLeadOpptyContactSalesRoleRelation - HowTo - ImportMappingMask - InterfacePreview - Lead - LeadOppty - LeadOpptyAccountRelation - LeadOpptyContactGroupRelation - LeadOpptyContactRelation - LeadOpptyContactSalesRoleRelation - LeadOpptyDataExRelation - LeadOpptyKPI - LeadOpptyProjectRelation - LeadOpptySharingClientRelation - LeadOpptySharingSalesUnitRelation - LeadOpptyStepCheckListRelation - LeadOpptyType - LeadProcess - LeadType - MasterRight - Media - Memo - MemoComment - Message - MessageRelation - MessageSharingClientRelation - MessageSharingSalesUnitRelation - Note - NotificationSetting - OnlineForm - OnlineFormActivityLogLine - OnlineFormDataExRelation - OnlineFormRelation - OnlineFormStyle - OnlineFormType - OnlineFormTypeEmailRelation - Opportunity - OpportunityType - OpptyProductRelation - OpptyProductRelationDataExRelation - OpptyProductRelationRevenueSchedule - OpptyProductRelationRevenueSchedulePeriod - OpptyProductRelationType - OpptyRecurrence - OpptyRevenueSchedule - OpptyRevenueSchedulePeriod - Order - OrderHistory - OrderItem - OrderRelatedDocument - OrderTempData - OrderTempDataItem - ParentAccountRelationType - Partner - Payment - PaymentAdditionalData - PaymentTerm - Phone - Pipeline - Process - ProcessActivityLog - ProcessActivityLogLine - ProcessChangeOwnerLog - ProcessScheduledAction - ProcessTemplate - Product - ProductCategory - ProductDataExRelation - ProductPipelineRelation - ProductPriceList - ProductPriceListPrice - ProductType - Profile - ProfileDraft - ProfileRelation - ProfileSharingClientRelation - ProfileSharingSalesUnitRelation - Project - ProjectContactRelation - ProjectDataExRelation - ProjectKPI - ProjectObjective - ProjectSharingClientRelation - ProjectSharingSalesUnitRelation - ProjectType - PurchasedProduct - Quote - QuoteAccountRelation - QuoteContactRelation - QuoteDataExRelation - QuoteKPI - QuoteProcess - QuoteSharingClientRelation - QuoteSharingSalesUnitRelation - QuoteType - ReleaseNote - Report - ReportFolder - ReportSchedule - ReportSharingClientRelation - ReportSharingSalesUnitRelation - RevenueRecognition - SalesRole - SalesUnit - SalesUnitClientRelation - SapiUser - SpaceSetting - State - Step - StepChecklist - StepChecklistSalesRoleRelation - Storylane - Subscription - SubscriptionHubItem - SubscriptionNotification - SubscriptionRepresentative - SubscriptionSDR - Supplier - Tag - TagRelation - Target - TargetRelation - Task - TaskRecurrence - TaskReminder - TaskSharingClientRelation - TaskSharingSalesUnitRelation - TaskType - TeamPipelineHubItem - TeamPipelineHubItemBase - TeamSpace - TeamSpaceClient - TeamSpaceClientSetting - TeamSpaceProperty - TeamSpaceRegion - TextMessage - TextMessageConversation - TextMessageConversationRelations - Timeframe - Translation - Type - UnsubscribedPhone - UseCase - UserProfile - UserRole - Webhook - WebhookEvent - Webresource description: Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via template_entity_api_name. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. 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' example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 url: type: string example: string description: URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. content: type: string format: binary example: blob description: Data content of the object. template_entity_api_name: type: string example: string description: API name of the custom entity the template renders. Set only when template_entity_name is "CustomEntity"; otherwise empty. required: - filename - template_entity_name - type batchCloudObjectRelationInput: properties: cloud_object: type: object properties: id: type: string format: uri description: 'Cloud object (file) being linked. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' report_schedule: type: object properties: id: type: string format: uri description: 'Report schedule the file is attached to (e.g. an exported report). Relation to ReportSchedule, see: ''updateReportScheduleInput'' object for properties.' text_message: type: object properties: id: type: string format: uri description: 'Text message (SMS/MMS) the file is attached to. Relation to TextMessage, see: ''updateTextMessageInput'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked appointment or task, or empty when not linked. approval_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked approval process. call_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked call. cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder within the parent record, or empty when stored at the record root. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked file. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_sequence_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email sequence. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email template. field_mapping_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked field mapping. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. media_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked media record. message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email or memo, or empty when not linked. online_form_field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form field the file was uploaded into. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked online form submission. process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process. process_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process template. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. report_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked report schedule. text_message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked text message. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateCloudObjectRelationInput: properties: cloud_object: type: object properties: id: type: string format: uri description: 'Cloud object (file) being linked. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' report_schedule: type: object properties: id: type: string format: uri description: 'Report schedule the file is attached to (e.g. an exported report). Relation to ReportSchedule, see: ''updateReportScheduleInput'' object for properties.' text_message: type: object properties: id: type: string format: uri description: 'Text message (SMS/MMS) the file is attached to. Relation to TextMessage, see: ''updateTextMessageInput'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked account. activity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked appointment or task, or empty when not linked. approval_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked approval process. call_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked call. cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the folder within the parent record, or empty when stored at the record root. cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked file. contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked contact. custom_entity_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked custom entity record. email_sequence_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email sequence. email_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email template. field_mapping_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked field mapping. lead_oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked lead or opportunity, or empty when not linked. media_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked media record. message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked email or memo, or empty when not linked. online_form_field_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form field the file was uploaded into. online_form_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked online form submission. process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process. process_template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked sales process template. project_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked project. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked quote. report_schedule_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked report schedule. text_message_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked text message. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchCloudObjectInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). params: type: object description: Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateCloudObjectTemplateInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). status: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Active, 2 - Inactive' example: 1 enum: - 1 - 2 template_entity_name: type: string example: Account enum: - Account - AccountDataExRelation - AccountKPI - AccountProductPricing - AccountRole - AccountSharingClientRelation - AccountSharingSalesUnitRelation - AccountSocialRelation - AccountType - Activity - ActivityComment - ActivityDataExRelation - ActivityDetail - ActivityKPI - ActivityRelation - ActivityType - AiAgent - AiBalance - AiEvent - AiEventJournal - AllowedAccountType - AllowedCompanyPhone - AllowedContactType - AllowedLeadType - AllowedPipeline - AllowedQuoteType - ApiAccess - Application - Appointment - AppointmentClientInviteesRelation - AppointmentContactInviteesRelation - AppointmentInviteeNotifyQueue - AppointmentReminder - AppointmentSchedule - AppointmentType - Approval - ApprovalApprover - ApprovalProcess - ApprovalProcessActivityLogLine - AuditLog - AutomationHubApp - AutomationHubCategory - AutomationHubItem - ChatConversation - Client - ClientExcludedOppty - ClientFavorite - ClientSetting - ClientStoryRead - CloudObject - CloudObjectFolder - CloudObjectRelation - CloudObjectStepRelation - CloudObjectTemplate - CompanyEmail - Contact - ContactAccountAccountRoleRelation - ContactAccountRelation - ContactDataExRelation - ContactKPI - ContactRelation - ContactRelationType - ContactSharingClientRelation - ContactSharingSalesUnitRelation - ContactSocialRelation - ContactType - Country - CountryCrm - CpActivity - CpCallLog - CpCalling - CpClient - CpProduct - CpProfile - CpTeamSpaceClient - Currency - CurrencyExchangeRate - CurrencyExchangeRatesList - CustomEntity - CustomEntityDataExRelation - CustomEntityKPI - CustomEntityRelation - CustomEntityRelationData - CustomEntitySharingClientRelation - CustomEntitySharingSalesUnitRelation - CustomEntityType - Data - Ebook - Email - EmailContentSharingClientRelation - EmailContentSharingSalesUnitRelation - EmailMailboxRelation - EmailSequence - EmailSequenceActivityLog - EmailSequenceActivityLogLine - EmailSequenceEnrolled - EmailSequenceEnrolledStatus - EmailSequenceSettings - EmailTemplate - EmailTemplateFolder - EmailTemplateSharingClientRelation - EmailTemplateSharingSalesUnitRelation - EmailThreadMailboxClientReadState - Entity - EntityFitness - EntityFitnessIndicator - EntityHealth - EntityHealthSettingsHistory - EntityScoring - EntitySettings - EntityType - Field - FieldMapping - FieldPermission - FieldSequence - Forecast - ForecastSharingClientRelation - ForecastSharingSalesUnitRelation - FormView - FormViewSharingClientRelation - FormViewSharingSalesUnitRelation - GhostContact - GhostContactAccountAccountRoleRelation - GhostContactAccountRelation - GhostLeadOpptyContactRelation - GhostLeadOpptyContactSalesRoleRelation - HowTo - ImportMappingMask - InterfacePreview - Lead - LeadOppty - LeadOpptyAccountRelation - LeadOpptyContactGroupRelation - LeadOpptyContactRelation - LeadOpptyContactSalesRoleRelation - LeadOpptyDataExRelation - LeadOpptyKPI - LeadOpptyProjectRelation - LeadOpptySharingClientRelation - LeadOpptySharingSalesUnitRelation - LeadOpptyStepCheckListRelation - LeadOpptyType - LeadProcess - LeadType - MasterRight - Media - Memo - MemoComment - Message - MessageRelation - MessageSharingClientRelation - MessageSharingSalesUnitRelation - Note - NotificationSetting - OnlineForm - OnlineFormActivityLogLine - OnlineFormDataExRelation - OnlineFormRelation - OnlineFormStyle - OnlineFormType - OnlineFormTypeEmailRelation - Opportunity - OpportunityType - OpptyProductRelation - OpptyProductRelationDataExRelation - OpptyProductRelationRevenueSchedule - OpptyProductRelationRevenueSchedulePeriod - OpptyProductRelationType - OpptyRecurrence - OpptyRevenueSchedule - OpptyRevenueSchedulePeriod - Order - OrderHistory - OrderItem - OrderRelatedDocument - OrderTempData - OrderTempDataItem - ParentAccountRelationType - Partner - Payment - PaymentAdditionalData - PaymentTerm - Phone - Pipeline - Process - ProcessActivityLog - ProcessActivityLogLine - ProcessChangeOwnerLog - ProcessScheduledAction - ProcessTemplate - Product - ProductCategory - ProductDataExRelation - ProductPipelineRelation - ProductPriceList - ProductPriceListPrice - ProductType - Profile - ProfileDraft - ProfileRelation - ProfileSharingClientRelation - ProfileSharingSalesUnitRelation - Project - ProjectContactRelation - ProjectDataExRelation - ProjectKPI - ProjectObjective - ProjectSharingClientRelation - ProjectSharingSalesUnitRelation - ProjectType - PurchasedProduct - Quote - QuoteAccountRelation - QuoteContactRelation - QuoteDataExRelation - QuoteKPI - QuoteProcess - QuoteSharingClientRelation - QuoteSharingSalesUnitRelation - QuoteType - ReleaseNote - Report - ReportFolder - ReportSchedule - ReportSharingClientRelation - ReportSharingSalesUnitRelation - RevenueRecognition - SalesRole - SalesUnit - SalesUnitClientRelation - SapiUser - SpaceSetting - State - Step - StepChecklist - StepChecklistSalesRoleRelation - Storylane - Subscription - SubscriptionHubItem - SubscriptionNotification - SubscriptionRepresentative - SubscriptionSDR - Supplier - Tag - TagRelation - Target - TargetRelation - Task - TaskRecurrence - TaskReminder - TaskSharingClientRelation - TaskSharingSalesUnitRelation - TaskType - TeamPipelineHubItem - TeamPipelineHubItemBase - TeamSpace - TeamSpaceClient - TeamSpaceClientSetting - TeamSpaceProperty - TeamSpaceRegion - TextMessage - TextMessageConversation - TextMessageConversationRelations - Timeframe - Translation - Type - UnsubscribedPhone - UseCase - UserProfile - UserRole - Webhook - WebhookEvent - Webresource description: Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via template_entity_api_name. upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. content: type: string format: binary example: blob description: Data content of the object. template_entity_api_name: type: string example: string description: API name of the custom entity the template renders. Set only when template_entity_name is "CustomEntity"; otherwise empty. updateCloudObjectInput: properties: application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). params: type: object description: Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchCloudObjectStepRelationInput: properties: cloud_object: type: object properties: id: type: string format: uri description: 'File attached to the step. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' cloud_object_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the attached file. sort_order: type: integer format: int32 example: 1 description: Position of the file within the step's document list. step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the pipeline step. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateCloudObjectFolderInput: properties: entity_api_name: type: string example: string description: API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. name: type: string example: string description: Name of the entity and its default text representation. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form template, or empty when not associated with a form. parent_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder, or empty for top-level folders. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchCloudObjectFolderInput: properties: entity_api_name: type: string example: string description: API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. name: type: string example: string description: Name of the entity and its default text representation. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form template, or empty when not associated with a form. parent_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder, or empty for top-level folders. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid CloudObjectFolder: properties: is_delete_protected: type: boolean example: false description: 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. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true online_form_type: type: string format: uri description: 'Online form template this folder is associated with, when the folder stores form submissions. Relation to OnlineFormType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OnlineFormType'' object for properties.' parent_cloud_object_folder: type: string format: uri description: 'Parent folder, when this folder is nested. Empty for top-level folders. 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.' entity_api_name: type: string example: string description: API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty. entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 name: type: string example: string description: Name of the entity and its default text representation. online_form_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the online form template, or empty when not associated with a form. parent_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent folder, or empty for top-level folders. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - name createCloudObjectInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the producing application. company_cloud_object_folder_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the company folder, or empty when the object is not stored in the company tree. creator_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the uploading user. filename: type: string example: string description: File name (with extension) used when downloading the object. is_public: type: boolean example: false description: When true, the object can be served via a public URL (see public_url). mime_type: type: string example: string description: Mime-type of the cloud object Is detected from content. readOnly: true params: type: object description: Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object. type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. 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' example: -1 enum: - -1 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 readOnly: true upload_source: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - EmailTemplate, 2 - RichTextEditor' example: 1 enum: - 1 - 2 url: type: string example: string description: URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. content: type: string format: binary example: blob description: Data content of the object. required: - filename - type