GraphQL RepositoriescloudObject

`entities.cloudObject`

Read cloud object records with the cloudObject repository, and change them with the cloud object mutations. Same records as the REST CloudObjects entity.

Example: first three cloud object recordsGraphQLcURL

query FirstCloudObjects {
  entities {
    cloudObject {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstCloudObjects { entities { cloudObject { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { cloudObject { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	CloudObjectEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CloudObjectEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CloudObjectFilterInput, orderBy: [CloudObjectOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean) Returns the files that match the filter, paged with limit and offset.	[CloudObjectEntity!]!
QUERY	`getByCriteria`(filter: CloudObjectFilterInput, orderBy: [CloudObjectOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean, before: String, after: String, first: Int, last: Int) Returns the files that match the filter as a cursor-paginated connection.	CloudObjectEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!
QUERY	`getSignedUrls`(urls: [String!]!, expireIn: Int) Returns SignedUrl with public downloadable url link and their id.	[SignedUrl!]!
QUERY	`getDocumentPreviewUrl`(entityId: UUID!) Returns a URL of a PDF preview of an Office document (Word, Excel or PowerPoint file). When the preview cannot be produced, the URL is null and the error explains why.	DocumentPreviewUrl!
QUERY	`getBySession`(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int) Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.	CloudObjectEntityConnection
QUERY	`getByIdsForProcess`(processId: UUID!, entityIds: [UUID!]!) Returns those of the given files that are attached to the process or to any email template. Ids of other files are ignored.	[CloudObjectEntity!]!
QUERY	`getByIdsForEmailSequence`(emailSequenceId: UUID!, entityIds: [UUID!]!) Returns those of the given files that are attached to the email sequence. Ids of files not attached to it are ignored.	[CloudObjectEntity!]!
QUERY	`getByIdsForReportSchedule`(reportScheduleId: UUID!, entityIds: [UUID!]!) Returns those of the given files that are attached to the report schedule. Ids of files not attached to it are ignored.	[CloudObjectEntity!]!
QUERY	`getByIdsForApprovalProcess`(approvalProcessId: UUID!, entityIds: [UUID!]!) Returns those of the given files that are attached to the approval process. Ids of files not attached to it are ignored.	[CloudObjectEntity!]!
QUERY	`getByIdsForFieldMapping`(fieldMappingId: UUID!, entityIds: [UUID!]!) Returns those of the given files that are attached to the field mapping. Ids of files not attached to it are ignored.	[CloudObjectEntity!]!
QUERY	`getByIdsForOnlineFormType`(onlineFormTypeId: UUID!, entityIds: [UUID!]!) Returns those of the given files that were uploaded with a submission of the online form. Ids of other files are ignored.	[CloudObjectEntity!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createCloudObject`(input: CreateCloudObjectInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCloudObjectPayload
MUTATION	`updateCloudObject`(input: UpdateCloudObjectInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCloudObjectPayload
MUTATION	`bulkUpdateCloudObject`(input: [CreateOrUpdateCloudObjectInput!]!, deleteInput: [DeleteCloudObjectInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCloudObjectPayload
MUTATION	`deleteCloudObject`(input: DeleteCloudObjectInput!)	Soft-delete	DeleteCloudObjectPayload
MUTATION	`createImageCloudObject`(input: CreateImageInput!, validationLevel: [ValidationLevel!])	Uploads an image and stores it as a new file in the space. GraphQL only	CreateImageCloudObjectPayload
MUTATION	`cloudObjectMakePublic`(input: CloudObjectMakePublicInput!)	Makes the file publicly accessible and returns its public URL. Anyone with the URL can download the file without signing in. GraphQL only	CloudObjectMakePublicPayload
MUTATION	`moveCloudObjects`(input: MoveCloudObjectsInput!)	Move to another step GraphQL only	MoveCloudObjectsPayload
MUTATION	`deleteCloudObjects`(input: DeleteCloudObjectsInput!)	Soft-delete	DeleteCloudObjectsPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

CloudObjectEntity object 24 fields: isDeleteProtected, id, isDeleted, …

File stored in the space, such as a document, image or recording, that can be attached to records.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`application`	ApplicationEntity	Application that produced the object (e.g. Online Forms).
`companyCloudObjectFolder`	CloudObjectFolderEntity	Company-level folder that contains the object, when stored in the company document tree.
`creator`	ClientEntity	User who uploaded the object.
`applicationId`	ID	Id of the producing application.
`companyCloudObjectFolderId`	ID	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	ID	Id of the uploading user.
`filename`	String!	File name (with extension) used when downloading the object.
`isPublic`	Boolean	When true, the object can be served via a public URL (see publicUrl).
`mimeType`	String	Mime-type of the cloud object Is detected from content.
`params`	JSONString	Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.
`size`	Int!	Size of the object in bytes.
`type`	CloudObjectTypeEnum!	Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only.
`uploadSource`	UploadSourceEnum	Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.
`url`	String	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	Int	Revision when entity was lastly changed.
`dimensions`	CloudObjectDimensions	Width and height of the image in pixels; empty for files that are not images.
`duration`	Float	Duration of the audio recording in seconds; empty for other files.
`publicUrl`	String	Publicly accessible link to the file; empty unless the file is marked as public.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CloudObjectEntityConnection object pageInfo: PageInfo!, edges: [CloudObjectEntityEdge]!, totalCount: Int

Paginated list of CloudObject records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[CloudObjectEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

CloudObjectEntityEdge object node: CloudObjectEntity, cursor: String!

A Relay edge containing a CloudObjectEntity and its cursor.

Field	Type	Description
`node`	CloudObjectEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

CloudObjectFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for CloudObject records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[CloudObjectFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CloudObjectFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CloudObjectFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`applicationId`	EntityFilterStringField	Id of the producing application.
`companyCloudObjectFolderId`	EntityFilterStringField	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	EntityFilterStringField	Id of the uploading user.
`filename`	EntityFilterStringField	File name (with extension) used when downloading the object.
`isPublic`	Boolean	When true, the object can be served via a public URL (see publicUrl).
`mimeType`	EntityFilterStringField	Mime-type of the cloud object Is detected from content.
`size`	EntityFilterNumberField	Size of the object in bytes.
`type`	CloudObjectTypeEnumFilterInput	Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only.
`uploadSource`	UploadSourceEnumFilterInput	Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.
`url`	EntityFilterStringField	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`application`	ApplicationFilterInput	Application that produced the object (e.g. Online Forms). Matches records where a related record meets these conditions.
`companyCloudObjectFolder`	CloudObjectFolderFilterInput	Company-level folder that contains the object, when stored in the company document tree. Matches records where a related record meets these conditions.
`creator`	ClientFilterInput	User who uploaded the object. Matches records where a related record meets these conditions.

CloudObjectOrderByInput input Asc or Desc per field

Sorting of CloudObject records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`application`	[ApplicationOrderByNestedInput!]	Application that produced the object (e.g. Online Forms). Sorts by fields of the related record, listed in order of priority.
`companyCloudObjectFolder`	[CloudObjectFolderOrderByNestedInput!]	Company-level folder that contains the object, when stored in the company document tree. Sorts by fields of the related record, listed in order of priority.
`creator`	[ClientOrderByNestedInput!]	User who uploaded the object. Sorts by fields of the related record, listed in order of priority.
`applicationId`	OrderByEnum	Id of the producing application.
`companyCloudObjectFolderId`	OrderByEnum	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	OrderByEnum	Id of the uploading user.
`filename`	OrderByEnum	File name (with extension) used when downloading the object.
`isPublic`	OrderByEnum	When true, the object can be served via a public URL (see publicUrl).
`mimeType`	OrderByEnum	Mime-type of the cloud object Is detected from content.
`size`	OrderByEnum	Size of the object in bytes.
`url`	OrderByEnum	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CloudObjectMakePublicInput input entityId: UUID!, clientMutationId: String

Parameters of the cloudObjectMakePublic mutation.

Input field	Type	Description
`entityId`	UUID!	Id of the file to make public.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateCloudObjectInput input 15 fields: clientMutationId, modified, created, …

Field values of a new CloudObject record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`applicationId`	ID	Id of the producing application.
`companyCloudObjectFolderId`	ID	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	ID	Id of the uploading user.
`filename`	String!	File name (with extension) used when downloading the object.
`isPublic`	Boolean	When true, the object can be served via a public URL (see publicUrl).
`mimeType`	String	Mime-type of the cloud object Is detected from content.
`params`	JSONString	Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.
`type`	CloudObjectTypeEnum!	Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only.
`uploadSource`	UploadSourceEnum	Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.
`url`	String	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	Int	Revision when entity was lastly changed.
`content`	Base64	Data content of the object.

CreateImageInput input filename: String!, content: String!, uploadSource: UploadSourceEnum

Parameters of the createImageCloudObject mutation.

Input field	Type	Description
`filename`	String!	File name of the image, including its extension.
`content`	String!	Image content, base64-encoded.
`uploadSource`	UploadSourceEnum	Editor the image is embedded in (e-mail template or rich-text editor). Leave empty for an image that is not embedded.

CreateOrUpdateCloudObjectInput input 16 fields: clientMutationId, id, modified, …

Field values of a CloudObject record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`applicationId`	ID	Id of the producing application.
`companyCloudObjectFolderId`	ID	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	ID	Id of the uploading user.
`filename`	String	File name (with extension) used when downloading the object.
`isPublic`	Boolean	When true, the object can be served via a public URL (see publicUrl).
`mimeType`	String	Mime-type of the cloud object Is detected from content.
`params`	JSONString	Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.
`type`	CloudObjectTypeEnum	Where the file is stored and how its content is obtained: a file in Coevera storage, a file linked from a cloud drive such as Google Drive or OneDrive, or an external URL. Set on create only.
`uploadSource`	UploadSourceEnum	Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.
`url`	String	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	Int	Revision when entity was lastly changed.
`content`	Base64	Data content of the object.

DeleteCloudObjectInput input clientMutationId: String, id: ID!

Id of the CloudObject record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

DeleteCloudObjectsInput input bulkFilter: BulkOperationInput!, clientMutationId: String

Parameters of the deleteCloudObjects mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Files and folders to delete.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

MoveCloudObjectsInput input 5 fields: bulkFilter, folderId, entityId, …

Parameters of the moveCloudObjects mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Files and folders to move.
`folderId`	UUID	Target folder. Required for company documents; for record documents, leave empty to move the files to the record's root.
`entityId`	UUID	Id of the record whose documents are moved. Set together with entityType.
`entityType`	BaseEntityTypeEnum	Type of the record whose documents are moved: Account, Contact, Lead, Opportunity, Task, Appointment, Project, Quote or CustomEntity. Set together with entityId.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateCloudObjectInput input 13 fields: clientMutationId, id, modified, …

Id of a CloudObject record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`applicationId`	ID	Id of the producing application.
`companyCloudObjectFolderId`	ID	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	ID	Id of the uploading user.
`filename`	String	File name (with extension) used when downloading the object.
`isPublic`	Boolean	When true, the object can be served via a public URL (see publicUrl).
`params`	JSONString	Additional metadata about the object (e.g. image dimensions, audio duration), as a JSON object.
`uploadSource`	UploadSourceEnum	Editor the uploaded image is embedded in, such as an email template or rich-text content. Empty for files that are not embedded images.
`url`	String	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCloudObjectPayload object result: BulkUpdateResults!

Result of the bulkUpdateCloudObject mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CloudObjectMakePublicPayload object result: String!, clientMutationId: String

Result of the cloudObjectMakePublic mutation.

Field	Type	Description
`result`	String!	Public URL of the file.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateCloudObjectPayload object cloudObject: CloudObjectEntity, clientMutationId: String

Result of the createCloudObject mutation.

Field	Type	Description
`cloudObject`	CloudObjectEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateImageCloudObjectPayload object cloudObject: CloudObjectEntity

Result of the createImageCloudObject mutation.

Field	Type	Description
`cloudObject`	CloudObjectEntity	The created file.

DeleteCloudObjectPayload object cloudObject: CloudObjectEntity, clientMutationId: String

Result of the deleteCloudObject mutation.

Field	Type	Description
`cloudObject`	CloudObjectEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteCloudObjectsPayload object clientMutationId: String

Result of the deleteCloudObjects mutation.

Field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

MoveCloudObjectsPayload object result: Boolean!, clientMutationId: String

Result of the moveCloudObjects mutation.

Field	Type	Description
`result`	Boolean!	True when all given files were moved.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateCloudObjectPayload object cloudObject: CloudObjectEntity, clientMutationId: String

Result of the updateCloudObject mutation.

Field	Type	Description
`cloudObject`	CloudObjectEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CloudObjectDimensions object width: Int!, height: Int!

Width and height of an image file, in pixels.

Field	Type	Description
`width`	Int!	Width of the image in pixels.
`height`	Int!	Height of the image in pixels.