GraphQL RepositoriescloudObjectTemplate

`entities.cloudObjectTemplate`

Read cloud object template records with the cloudObjectTemplate repository, and change them with the cloud object template mutations. Same records as the REST CloudObjectTemplates entity.

Example: first three cloud object template recordsGraphQLcURL

query FirstCloudObjectTemplates {
  entities {
    cloudObjectTemplate {
      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 FirstCloudObjectTemplates { entities { cloudObjectTemplate { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { cloudObjectTemplate { … } }.

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.	CloudObjectTemplateEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CloudObjectTemplateEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CloudObjectTemplateFilterInput, orderBy: [CloudObjectTemplateOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean) Returns the files that match the filter, paged with limit and offset.	[CloudObjectTemplateEntity!]!
QUERY	`getByCriteria`(filter: CloudObjectTemplateFilterInput, orderBy: [CloudObjectTemplateOrderByInput!], includeDeleted: Boolean, includeOwned: Boolean, before: String, after: String, first: Int, last: Int) Returns the files that match the filter as a cursor-paginated connection.	CloudObjectTemplateEntityConnection
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!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createCloudObjectTemplate`(input: CreateCloudObjectTemplateInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCloudObjectTemplatePayload
MUTATION	`updateCloudObjectTemplate`(input: UpdateCloudObjectTemplateInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCloudObjectTemplatePayload
MUTATION	`bulkUpdateCloudObjectTemplate`(input: [CreateOrUpdateCloudObjectTemplateInput!]!, deleteInput: [DeleteCloudObjectTemplateInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCloudObjectTemplatePayload
MUTATION	`deleteCloudObjectTemplate`(input: DeleteCloudObjectTemplateInput!)	Soft-delete	DeleteCloudObjectTemplatePayload

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.

CloudObjectTemplateEntity object 23 fields: isDeleteProtected, id, isDeleted, …

Document template, such as a Word or Excel file with placeholders, used to generate documents filled with record data.

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.
`size`	Int!	Size of the object in bytes.
`status`	CloudObjectTemplateStatusEnum	Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.
`templateEntityName`	EntityNameEnum!	Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName.
`type`	CloudObjectTypeEnum!	Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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.
`templateEntityApiName`	String	API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CloudObjectTemplateEntityConnection object pageInfo: PageInfo!, edges: [CloudObjectTemplateEntityEdge]!, totalCount: Int

Paginated list of CloudObjectTemplate records.

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

CloudObjectTemplateEntityEdge object node: CloudObjectTemplateEntity, cursor: String!

A Relay edge containing a CloudObjectTemplateEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CloudObjectTemplateFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CloudObjectTemplateFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CloudObjectTemplateFilterInput	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.
`status`	CloudObjectTemplateStatusEnumFilterInput	Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.
`templateEntityName`	EntityNameEnum	Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName.
`type`	CloudObjectTypeEnumFilterInput	Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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.
`templateEntityApiName`	String	API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty.
`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.

CloudObjectTemplateOrderByInput input Asc or Desc per field

Sorting of CloudObjectTemplate 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.
`status`	OrderByEnum	Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.
`templateEntityName`	OrderByEnum	Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName.
`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.
`templateEntityApiName`	OrderByEnum	API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty.

CloudObjectTemplateStatusEnumFilterInput input eq: [CloudObjectTemplateStatusEnum!], NOT: CloudObjectTemplateStatusEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[CloudObjectTemplateStatusEnum!]	Matches any of the listed values.
`NOT`	CloudObjectTemplateStatusEnumFilterInput	Matches values that do not meet this condition.

CreateCloudObjectTemplateInput input 16 fields: clientMutationId, modified, created, …

Field values of a new CloudObjectTemplate 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).
`status`	CloudObjectTemplateStatusEnum	Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.
`templateEntityName`	EntityNameEnum!	Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName.
`type`	CloudObjectTypeEnum!	Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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.
`templateEntityApiName`	String	API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty.

CreateOrUpdateCloudObjectTemplateInput input 17 fields: clientMutationId, id, modified, …

Field values of a CloudObjectTemplate 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).
`status`	CloudObjectTemplateStatusEnum	Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.
`templateEntityName`	EntityNameEnum	Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName.
`type`	CloudObjectTypeEnum	Where the template file is stored: S3File for a file uploaded to Coevera storage (the default) or GoogleDriveFile for a Google Drive document. 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.
`templateEntityApiName`	String	API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty.

DeleteCloudObjectTemplateInput input clientMutationId: String, id: ID!

Id of the CloudObjectTemplate 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.

UpdateCloudObjectTemplateInput input 15 fields: clientMutationId, id, modified, …

Id of a CloudObjectTemplate 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).
`status`	CloudObjectTemplateStatusEnum	Whether the document template is active and offered for generating documents, or inactive and kept for later use. Defaults to Active.
`templateEntityName`	EntityNameEnum	Entity type the template renders (e.g. Account, Opportunity, Quote). For custom entities, the value is "CustomEntity" and the API name is exposed via templateEntityApiName.
`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.
`revision`	Int	Revision when entity was lastly changed.
`content`	Base64	Data content of the object.
`templateEntityApiName`	String	API name of the custom entity the template renders. Set only when templateEntityName is "CustomEntity"; otherwise empty.

BulkUpdateCloudObjectTemplatePayload object result: BulkUpdateResults!

Result of the bulkUpdateCloudObjectTemplate mutation.

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

CreateCloudObjectTemplatePayload object cloudObjectTemplate: CloudObjectTemplateEntity, clientMutationId: String

Result of the createCloudObjectTemplate mutation.

Field	Type	Description
`cloudObjectTemplate`	CloudObjectTemplateEntity	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).

DeleteCloudObjectTemplatePayload object cloudObjectTemplate: CloudObjectTemplateEntity, clientMutationId: String

Result of the deleteCloudObjectTemplate mutation.

Field	Type	Description
`cloudObjectTemplate`	CloudObjectTemplateEntity	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).

UpdateCloudObjectTemplatePayload object cloudObjectTemplate: CloudObjectTemplateEntity, clientMutationId: String

Result of the updateCloudObjectTemplate mutation.

Field	Type	Description
`cloudObjectTemplate`	CloudObjectTemplateEntity	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).

CloudObjectTemplateStatusEnum enum Active, Inactive

Whether a document template is available for use.

Value	Description
`Active`	Template is available for generating documents.
`Inactive`	Template is kept but not offered for generating documents.