GraphQL RepositoriescloudObjectFolder

`entities.cloudObjectFolder`

Read cloud object folder records with the cloudObjectFolder repository, and change them with the cloud object folder mutations. Same records as the REST CloudObjectFolders entity.

Example: first three cloud object folder recordsGraphQLcURL

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

Queries

Fields of entities { cloudObjectFolder { … } }.

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

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createCloudObjectFolder`(input: CreateCloudObjectFolderInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCloudObjectFolderPayload
MUTATION	`updateCloudObjectFolder`(input: UpdateCloudObjectFolderInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCloudObjectFolderPayload
MUTATION	`bulkUpdateCloudObjectFolder`(input: [CreateOrUpdateCloudObjectFolderInput!]!, deleteInput: [DeleteCloudObjectFolderInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCloudObjectFolderPayload
MUTATION	`deleteCloudObjectFolder`(input: DeleteCloudObjectFolderInput!, deleteContents: Boolean)	Soft-delete	DeleteCloudObjectFolderPayload

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.

CloudObjectFolderEntity object 15 fields: isDeleteProtected, id, isDeleted, …

Folder that organizes files, either in the company documents or within a record.

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.
`onlineFormType`	OnlineFormTypeEntity	Online form template this folder is associated with, when the folder stores form submissions.
`parentCloudObjectFolder`	CloudObjectFolderEntity	Parent folder, when this folder is nested. Empty for top-level folders.
`entityApiName`	String	API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
`entityType`	BaseEntityTypeEnum	Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
`name`	String!	Name of the entity and its default text representation.
`onlineFormTypeId`	ID	Id of the online form template, or empty when not associated with a form.
`parentCloudObjectFolderId`	ID	Id of the parent folder, or empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.
`type`	CloudObjectFolderType!	Folder kind: Company for shared company folders, Record for folders attached to a specific record.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CloudObjectFolderEntityConnection object pageInfo: PageInfo!, edges: [CloudObjectFolderEntityEdge]!, totalCount: Int

Paginated list of CloudObjectFolder records.

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

CloudObjectFolderEntityEdge object node: CloudObjectFolderEntity, cursor: String!

A Relay edge containing a CloudObjectFolderEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CloudObjectFolderFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CloudObjectFolderFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CloudObjectFolderFilterInput	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.
`entityApiName`	EntityFilterStringField	API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
`entityType`	BaseEntityTypeEnumFilterInput	Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`onlineFormTypeId`	EntityFilterStringField	Id of the online form template, or empty when not associated with a form.
`parentCloudObjectFolderId`	EntityFilterStringField	Id of the parent folder, or empty for top-level folders.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`type`	CloudObjectFolderType	Folder kind: Company for shared company folders, Record for folders attached to a specific record.
`onlineFormType`	OnlineFormTypeFilterInput	Online form template this folder is associated with, when the folder stores form submissions. Matches records where a related record meets these conditions.
`parentCloudObjectFolder`	CloudObjectFolderFilterInput	Parent folder, when this folder is nested. Empty for top-level folders. Matches records where a related record meets these conditions.

CloudObjectFolderOrderByInput input Asc or Desc per field

Sorting of CloudObjectFolder 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.
`onlineFormType`	[OnlineFormTypeOrderByNestedInput!]	Online form template this folder is associated with, when the folder stores form submissions. Sorts by fields of the related record, listed in order of priority.
`parentCloudObjectFolder`	[CloudObjectFolderOrderByNestedInput!]	Parent folder, when this folder is nested. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority.
`entityApiName`	OrderByEnum	API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
`name`	OrderByEnum	Name of the entity and its default text representation.
`onlineFormTypeId`	OrderByEnum	Id of the online form template, or empty when not associated with a form.
`parentCloudObjectFolderId`	OrderByEnum	Id of the parent folder, or empty for top-level folders.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`type`	OrderByEnum	Folder kind: Company for shared company folders, Record for folders attached to a specific record.

CreateCloudObjectFolderInput input 9 fields: clientMutationId, modified, created, …

Field values of a new CloudObjectFolder 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.
`entityApiName`	String	API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
`entityType`	BaseEntityTypeEnum	Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
`name`	String!	Name of the entity and its default text representation.
`onlineFormTypeId`	ID	Id of the online form template, or empty when not associated with a form.
`parentCloudObjectFolderId`	ID	Id of the parent folder, or empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateCloudObjectFolderInput input 10 fields: clientMutationId, id, modified, …

Field values of a CloudObjectFolder 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.
`entityApiName`	String	API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
`entityType`	BaseEntityTypeEnum	Entity of the record the folder belongs to (lead, opportunity, account, contact, project, quote or custom entity). Empty for company folders; set on create only.
`name`	String	Name of the entity and its default text representation.
`onlineFormTypeId`	ID	Id of the online form template, or empty when not associated with a form.
`parentCloudObjectFolderId`	ID	Id of the parent folder, or empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.

DeleteCloudObjectFolderInput input clientMutationId: String, id: ID!

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

UpdateCloudObjectFolderInput input 9 fields: clientMutationId, id, modified, …

Id of a CloudObjectFolder 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.
`entityApiName`	String	API name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
`name`	String	Name of the entity and its default text representation.
`onlineFormTypeId`	ID	Id of the online form template, or empty when not associated with a form.
`parentCloudObjectFolderId`	ID	Id of the parent folder, or empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateCloudObjectFolderPayload object result: BulkUpdateResults!

Result of the bulkUpdateCloudObjectFolder mutation.

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

CreateCloudObjectFolderPayload object cloudObjectFolder: CloudObjectFolderEntity, clientMutationId: String

Result of the createCloudObjectFolder mutation.

Field	Type	Description
`cloudObjectFolder`	CloudObjectFolderEntity	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).

DeleteCloudObjectFolderPayload object errors: Boolean!, cloudObjectFolder: CloudObjectFolderEntity!, clientMutationId: String

Result of the deleteCloudObjectFolder mutation.

Field	Type	Description
`errors`	Boolean!	The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept.
`cloudObjectFolder`	CloudObjectFolderEntity!	The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept.
`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).

UpdateCloudObjectFolderPayload object cloudObjectFolder: CloudObjectFolderEntity, clientMutationId: String

Result of the updateCloudObjectFolder mutation.

Field	Type	Description
`cloudObjectFolder`	CloudObjectFolderEntity	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).

CloudObjectFolderType enum Company, Record

Kind of document folder.

Value	Description
`Company`	Shared company folder, not tied to a record.
`Record`	Folder attached to a specific record.