OBJECT
CloudObjectRepository

Read operations for CloudObject records.
GraphQL Schema definition

type CloudObjectRepository {
# Returns the record with the given id, or null when there is none. Deleted 
# records are returned as well.
# 
# Arguments
# entityId: Id of the record to return.
getById(entityId: ID!): CloudObjectEntity 
# Returns the records with the given ids; ids without a record are left out. 
# Deleted records are returned as well.
# 
# Arguments
# entityIds: Ids of the records to return.
getByIds(entityIds: [ID!]!): [CloudObjectEntity!]! 
# Returns the files that match the filter, paged with limit and offset.
# 
# Arguments
# limit: Maximum number of records to return.
# offset: Number of records to skip from the start of the result.
# filter: Conditions the returned records must meet.
# orderBy: Sorting of the returned records.
# includeDeleted: When true, deleted records are returned as 
# well. Defaults to false.
# includeOwned: When true, also returns files the current user 
# uploaded and images used in online forms or embedded in editors, even when no 
# record visible to the user links to them. Defaults to false.
getAll(
limit: Int,
offset: Int,
filter: CloudObjectFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
includeOwned: Boolean
): [CloudObjectEntity!]! 
# Returns the files that match the filter as a cursor-paginated connection.
# 
# Arguments
# filter: Conditions the returned records must meet.
# orderBy: Sorting of the returned records.
# includeDeleted: When true, deleted records are returned as 
# well. Defaults to false.
# includeOwned: When true, also returns files the current user 
# uploaded and images used in online forms or embedded in editors, even when no 
# record visible to the user links to them. Defaults to false.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
getByCriteria(
filter: CloudObjectFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
includeOwned: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectEntityConnection 
# Returns the ids of the fields of a record that changed after the given revision. 
# Returns an empty list for entities without change tracking.
# 
# Arguments
# id: Id of the record.
# revision: Revision to compare against; only later changes are 
# returned.
getChangedFieldsSinceRevision(
id: UUID!,
revision: Int!
): [UUID!]! 
# Returns SignedUrl with public downloadable url link and their id.
# 
# Arguments
# urls: List of urls to sign.
# expireIn: Seconds for url expiration.
getSignedUrls(urls: [String!]!, expireIn: Int): [SignedUrl!]! 
# 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.
# 
# Arguments
# entityId: Id of the document.
getDocumentPreviewUrl(entityId: UUID!): DocumentPreviewUrl! 
# 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.
# 
# Arguments
# includedIds: Ids of records to add to the selection.
# excludedIds: Ids of records to remove from the selection.
# sessionId: Id of the list or report result to take the records 
# from. Pass an empty string to select only the included ids.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
getBySession(
includedIds: [UUID!]!,
excludedIds: [UUID!]!,
sessionId: String!,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectEntityConnection 
# Returns those of the given files that are attached to the process or to any 
# email template. Ids of other files are ignored.
# 
# Arguments
# processId: Id of the process.
# entityIds: Ids of the files to look up.
getByIdsForProcess(processId: UUID!, entityIds: [UUID!]!): [CloudObjectEntity!]! 
# Returns those of the given files that are attached to the email sequence. Ids of 
# files not attached to it are ignored.
# 
# Arguments
# emailSequenceId: Id of the email sequence.
# entityIds: Ids of the files to look up.
getByIdsForEmailSequence(
emailSequenceId: UUID!,
entityIds: [UUID!]!
): [CloudObjectEntity!]! 
# Returns those of the given files that are attached to the report schedule. Ids 
# of files not attached to it are ignored.
# 
# Arguments
# reportScheduleId: Id of the report schedule.
# entityIds: Ids of the files to look up.
getByIdsForReportSchedule(
reportScheduleId: UUID!,
entityIds: [UUID!]!
): [CloudObjectEntity!]! 
# Returns those of the given files that are attached to the approval process. Ids 
# of files not attached to it are ignored.
# 
# Arguments
# approvalProcessId: Id of the approval process.
# entityIds: Ids of the files to look up.
getByIdsForApprovalProcess(
approvalProcessId: UUID!,
entityIds: [UUID!]!
): [CloudObjectEntity!]! 
# Returns those of the given files that are attached to the field mapping. Ids of 
# files not attached to it are ignored.
# 
# Arguments
# fieldMappingId: Id of the field mapping.
# entityIds: Ids of the files to look up.
getByIdsForFieldMapping(
fieldMappingId: UUID!,
entityIds: [UUID!]!
): [CloudObjectEntity!]! 
# Returns those of the given files that were uploaded with a submission of the 
# online form. Ids of other files are ignored.
# 
# Arguments
# onlineFormTypeId: Id of the online form.
# entityIds: Ids of the files to look up.
getByIdsForOnlineFormType(
onlineFormTypeId: UUID!,
entityIds: [UUID!]!
): [CloudObjectEntity!]! 
}
Require by

EntityRepositoryRegistryEntry point for reading records; each field holds the read operations of one entity.
CloudObjectRepository

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
