GraphQLRepositoriescloudObjectRelation
entities.cloudObjectRelation
Read cloud object relation records with the cloudObjectRelation repository, and change them with the cloud object relation mutations. Same records as the REST CloudObjectRelations entity.
Queries
Fields of entities { cloudObjectRelation { … } }.
| 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. | CloudObjectRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [CloudObjectRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: CloudObjectRelationFilterInput, orderBy: [CloudObjectRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [CloudObjectRelationEntity!]! |
| QUERY | getByCriteria(filter: CloudObjectRelationFilterInput, orderBy: [CloudObjectRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | CloudObjectRelationEntityConnection |
| 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 | createCloudObjectRelation(input: CreateCloudObjectRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateCloudObjectRelationPayload |
| MUTATION | updateCloudObjectRelation(input: UpdateCloudObjectRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateCloudObjectRelationPayload |
| MUTATION | bulkUpdateCloudObjectRelation(input: [CreateOrUpdateCloudObjectRelationInput!]!, deleteInput: [DeleteCloudObjectRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateCloudObjectRelationPayload |
| MUTATION | deleteCloudObjectRelation(input: DeleteCloudObjectRelationInput!) | Soft-delete | DeleteCloudObjectRelationPayload |
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.
CloudObjectRelationEntity object 54 fields: isDeleteProtected, id, isDeleted, …
Attachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that 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. |
account | AccountEntity | Account the file is attached to, or empty when not attached to an account. |
appointment | AppointmentEntity | Appointment the file is attached to. Set when activityId resolves to an Appointment. |
task | TaskEntity | Task the file is attached to. Set when activityId resolves to a Task. |
approvalProcess | ApprovalProcessEntity | Approval process the file is attached to. |
call | CallEntity | Call the file is attached to (e.g. a call recording). |
cloudObjectFolder | CloudObjectFolderEntity | Folder the file is filed under within the parent record, or empty when stored at the record root. |
cloudObject | CloudObjectEntity | Cloud object (file) being linked. |
contact | ContactEntity | Contact the file is attached to, or empty when not attached to a contact. |
customEntity | CustomEntityEntity | Custom entity record the file is attached to. |
emailSequence | EmailSequenceEntity | Email sequence the file is attached to. |
emailTemplate | EmailTemplateEntity | Email template the file is attached to as a template attachment. |
fieldMapping | FieldMappingEntity | Field mapping the file is attached to (e.g. an import file). |
lead | LeadEntity | Lead the file is attached to. Set when leadOpptyId resolves to a Lead. |
oppty | OpportunityEntity | Opportunity the file is attached to. Set when leadOpptyId resolves to an Opportunity. |
media | MediaEntity | Media record the file is attached to. |
email | EmailEntity | Email the file is attached to (e.g. an email attachment). Set when messageId resolves to an Email. |
memo | MemoEntity | Memo the file is attached to. Set when messageId resolves to a Memo. |
onlineFormField | FieldEntity | Online form field the file was uploaded into. |
onlineForm | OnlineFormEntity | Online form submission the file was uploaded with. |
process | ProcessEntity | Sales process the file is attached to. |
processTemplate | ProcessTemplateEntity | Sales process template the file is attached to. |
project | ProjectEntity | Project the file is attached to. |
quote | QuoteEntity | Quote the file is attached to. |
reportSchedule | ReportScheduleEntity | Report schedule the file is attached to (e.g. an exported report). |
textMessage | TextMessageEntity | Text message (SMS/MMS) the file is attached to. |
accountId | ID | Id of the linked account. |
activityId | ID | Id of the linked appointment or task, or empty when not linked. |
approvalProcessId | ID | Id of the linked approval process. |
callId | ID | Id of the linked call. |
cloudObjectFolderId | ID | Id of the folder within the parent record, or empty when stored at the record root. |
cloudObjectId | ID | Id of the linked file. |
contactId | ID | Id of the linked contact. |
customEntityId | ID | Id of the linked custom entity record. |
emailSequenceId | ID | Id of the linked email sequence. |
emailTemplateId | ID | Id of the linked email template. |
fieldMappingId | ID | Id of the linked field mapping. |
leadOpptyId | ID | Id of the linked lead or opportunity, or empty when not linked. |
mediaId | ID | Id of the linked media record. |
messageId | ID | Id of the linked email or memo, or empty when not linked. |
onlineFormFieldId | ID | Id of the online form field the file was uploaded into. |
onlineFormId | ID | Id of the linked online form submission. |
processId | ID | Id of the linked sales process. |
processTemplateId | ID | Id of the linked sales process template. |
projectId | ID | Id of the linked project. |
quoteId | ID | Id of the linked quote. |
reportScheduleId | ID | Id of the linked report schedule. |
textMessageId | ID | Id of the linked text message. |
revision | Int | Revision when entity was lastly changed. |
instancePermissions | [EntityPermsEnum!]! (1 args) | Permissions the current user has on this record, out of the requested ones. |
CloudObjectRelationEntityConnection object pageInfo: PageInfo!, edges: [CloudObjectRelationEntityEdge]!, totalCount: Int
Paginated list of CloudObjectRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [CloudObjectRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
CloudObjectRelationEntityEdge object node: CloudObjectRelationEntity, cursor: String!
A Relay edge containing a CloudObjectRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | CloudObjectRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
CloudObjectRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for CloudObjectRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [CloudObjectRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [CloudObjectRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | CloudObjectRelationFilterInput | 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. |
accountId | EntityFilterStringField | Id of the linked account. |
activityId | EntityFilterStringField | Id of the linked appointment or task, or empty when not linked. |
approvalProcessId | EntityFilterStringField | Id of the linked approval process. |
callId | EntityFilterStringField | Id of the linked call. |
cloudObjectFolderId | EntityFilterStringField | Id of the folder within the parent record, or empty when stored at the record root. |
cloudObjectId | EntityFilterStringField | Id of the linked file. |
contactId | EntityFilterStringField | Id of the linked contact. |
customEntityId | EntityFilterStringField | Id of the linked custom entity record. |
emailSequenceId | EntityFilterStringField | Id of the linked email sequence. |
emailTemplateId | EntityFilterStringField | Id of the linked email template. |
fieldMappingId | EntityFilterStringField | Id of the linked field mapping. |
leadOpptyId | EntityFilterStringField | Id of the linked lead or opportunity, or empty when not linked. |
mediaId | EntityFilterStringField | Id of the linked media record. |
messageId | EntityFilterStringField | Id of the linked email or memo, or empty when not linked. |
onlineFormFieldId | EntityFilterStringField | Id of the online form field the file was uploaded into. |
onlineFormId | EntityFilterStringField | Id of the linked online form submission. |
processId | EntityFilterStringField | Id of the linked sales process. |
processTemplateId | EntityFilterStringField | Id of the linked sales process template. |
projectId | EntityFilterStringField | Id of the linked project. |
quoteId | EntityFilterStringField | Id of the linked quote. |
reportScheduleId | EntityFilterStringField | Id of the linked report schedule. |
textMessageId | EntityFilterStringField | Id of the linked text message. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
account | AccountFilterInput | Account the file is attached to, or empty when not attached to an account. Matches records where a related record meets these conditions. |
appointment | AppointmentFilterInput | Appointment the file is attached to. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. |
task | TaskFilterInput | Task the file is attached to. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. |
approvalProcess | ApprovalProcessFilterInput | Approval process the file is attached to. Matches records where a related record meets these conditions. |
call | CallFilterInput | Call the file is attached to (e.g. a call recording). Matches records where a related record meets these conditions. |
cloudObjectFolder | CloudObjectFolderFilterInput | Folder the file is filed under within the parent record, or empty when stored at the record root. Matches records where a related record meets these conditions. |
cloudObject | CloudObjectFilterInput | Cloud object (file) being linked. Matches records where a related record meets these conditions. |
contact | ContactFilterInput | Contact the file is attached to, or empty when not attached to a contact. Matches records where a related record meets these conditions. |
customEntity | CustomEntityFilterInput | Custom entity record the file is attached to. Matches records where a related record meets these conditions. |
emailSequence | EmailSequenceFilterInput | Email sequence the file is attached to. Matches records where a related record meets these conditions. |
emailTemplate | EmailTemplateFilterInput | Email template the file is attached to as a template attachment. Matches records where a related record meets these conditions. |
fieldMapping | FieldMappingFilterInput | Field mapping the file is attached to (e.g. an import file). Matches records where a related record meets these conditions. |
lead | LeadFilterInput | Lead the file is attached to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. |
oppty | OpportunityFilterInput | Opportunity the file is attached to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. |
media | MediaFilterInput | Media record the file is attached to. Matches records where a related record meets these conditions. |
email | EmailFilterInput | Email the file is attached to (e.g. an email attachment). Set when messageId resolves to an Email. Matches records where a related record meets these conditions. |
memo | MemoFilterInput | Memo the file is attached to. Set when messageId resolves to a Memo. Matches records where a related record meets these conditions. |
onlineFormField | FieldFilterInput | Online form field the file was uploaded into. Matches records where a related record meets these conditions. |
onlineForm | OnlineFormFilterInput | Online form submission the file was uploaded with. Matches records where a related record meets these conditions. |
process | ProcessFilterInput | Sales process the file is attached to. Matches records where a related record meets these conditions. |
processTemplate | ProcessTemplateFilterInput | Sales process template the file is attached to. Matches records where a related record meets these conditions. |
project | ProjectFilterInput | Project the file is attached to. Matches records where a related record meets these conditions. |
quote | QuoteFilterInput | Quote the file is attached to. Matches records where a related record meets these conditions. |
reportSchedule | ReportScheduleFilterInput | Report schedule the file is attached to (e.g. an exported report). Matches records where a related record meets these conditions. |
textMessage | TextMessageFilterInput | Text message (SMS/MMS) the file is attached to. Matches records where a related record meets these conditions. |
CloudObjectRelationOrderByInput input Asc or Desc per field
Sorting of CloudObjectRelation 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. |
account | [AccountOrderByNestedInput!] | Account the file is attached to, or empty when not attached to an account. Sorts by fields of the related record, listed in order of priority. |
appointment | [AppointmentOrderByNestedInput!] | Appointment the file is attached to. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. |
task | [TaskOrderByNestedInput!] | Task the file is attached to. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. |
approvalProcess | [ApprovalProcessOrderByNestedInput!] | Approval process the file is attached to. Sorts by fields of the related record, listed in order of priority. |
call | [CallOrderByNestedInput!] | Call the file is attached to (e.g. a call recording). Sorts by fields of the related record, listed in order of priority. |
cloudObjectFolder | [CloudObjectFolderOrderByNestedInput!] | Folder the file is filed under within the parent record, or empty when stored at the record root. Sorts by fields of the related record, listed in order of priority. |
contact | [ContactOrderByNestedInput!] | Contact the file is attached to, or empty when not attached to a contact. Sorts by fields of the related record, listed in order of priority. |
customEntity | [CustomEntityOrderByNestedInput!] | Custom entity record the file is attached to. Sorts by fields of the related record, listed in order of priority. |
emailSequence | [EmailSequenceOrderByNestedInput!] | Email sequence the file is attached to. Sorts by fields of the related record, listed in order of priority. |
emailTemplate | [EmailTemplateOrderByNestedInput!] | Email template the file is attached to as a template attachment. Sorts by fields of the related record, listed in order of priority. |
fieldMapping | [FieldMappingOrderByNestedInput!] | Field mapping the file is attached to (e.g. an import file). Sorts by fields of the related record, listed in order of priority. |
lead | [LeadOrderByNestedInput!] | Lead the file is attached to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. |
oppty | [OpportunityOrderByNestedInput!] | Opportunity the file is attached to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. |
media | [MediaOrderByNestedInput!] | Media record the file is attached to. Sorts by fields of the related record, listed in order of priority. |
email | [EmailOrderByNestedInput!] | Email the file is attached to (e.g. an email attachment). Set when messageId resolves to an Email. Sorts by fields of the related record, listed in order of priority. |
memo | [MemoOrderByNestedInput!] | Memo the file is attached to. Set when messageId resolves to a Memo. Sorts by fields of the related record, listed in order of priority. |
onlineFormField | [FieldOrderByNestedInput!] | Online form field the file was uploaded into. Sorts by fields of the related record, listed in order of priority. |
onlineForm | [OnlineFormOrderByNestedInput!] | Online form submission the file was uploaded with. Sorts by fields of the related record, listed in order of priority. |
process | [ProcessOrderByNestedInput!] | Sales process the file is attached to. Sorts by fields of the related record, listed in order of priority. |
processTemplate | [ProcessTemplateOrderByNestedInput!] | Sales process template the file is attached to. Sorts by fields of the related record, listed in order of priority. |
project | [ProjectOrderByNestedInput!] | Project the file is attached to. Sorts by fields of the related record, listed in order of priority. |
quote | [QuoteOrderByNestedInput!] | Quote the file is attached to. Sorts by fields of the related record, listed in order of priority. |
reportSchedule | [ReportScheduleOrderByNestedInput!] | Report schedule the file is attached to (e.g. an exported report). Sorts by fields of the related record, listed in order of priority. |
textMessage | [TextMessageOrderByNestedInput!] | Text message (SMS/MMS) the file is attached to. Sorts by fields of the related record, listed in order of priority. |
accountId | OrderByEnum | Id of the linked account. |
activityId | OrderByEnum | Id of the linked appointment or task, or empty when not linked. |
approvalProcessId | OrderByEnum | Id of the linked approval process. |
callId | OrderByEnum | Id of the linked call. |
cloudObjectFolderId | OrderByEnum | Id of the folder within the parent record, or empty when stored at the record root. |
contactId | OrderByEnum | Id of the linked contact. |
customEntityId | OrderByEnum | Id of the linked custom entity record. |
emailSequenceId | OrderByEnum | Id of the linked email sequence. |
emailTemplateId | OrderByEnum | Id of the linked email template. |
fieldMappingId | OrderByEnum | Id of the linked field mapping. |
leadOpptyId | OrderByEnum | Id of the linked lead or opportunity, or empty when not linked. |
mediaId | OrderByEnum | Id of the linked media record. |
messageId | OrderByEnum | Id of the linked email or memo, or empty when not linked. |
onlineFormFieldId | OrderByEnum | Id of the online form field the file was uploaded into. |
onlineFormId | OrderByEnum | Id of the linked online form submission. |
processId | OrderByEnum | Id of the linked sales process. |
processTemplateId | OrderByEnum | Id of the linked sales process template. |
projectId | OrderByEnum | Id of the linked project. |
quoteId | OrderByEnum | Id of the linked quote. |
reportScheduleId | OrderByEnum | Id of the linked report schedule. |
textMessageId | OrderByEnum | Id of the linked text message. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateCloudObjectRelationInput input 29 fields: clientMutationId, modified, created, …
Field values of a new CloudObjectRelation 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. |
cloudObject | CreateCloudObjectInput | Cloud object (file) being linked. |
reportSchedule | CreateReportScheduleInput | Report schedule the file is attached to (e.g. an exported report). |
textMessage | CreateTextMessageInput | Text message (SMS/MMS) the file is attached to. |
accountId | ID | Id of the linked account. |
activityId | ID | Id of the linked appointment or task, or empty when not linked. |
approvalProcessId | ID | Id of the linked approval process. |
callId | ID | Id of the linked call. |
cloudObjectFolderId | ID | Id of the folder within the parent record, or empty when stored at the record root. |
cloudObjectId | ID | Id of the linked file. |
contactId | ID | Id of the linked contact. |
customEntityId | ID | Id of the linked custom entity record. |
emailSequenceId | ID | Id of the linked email sequence. |
emailTemplateId | ID | Id of the linked email template. |
fieldMappingId | ID | Id of the linked field mapping. |
leadOpptyId | ID | Id of the linked lead or opportunity, or empty when not linked. |
mediaId | ID | Id of the linked media record. |
messageId | ID | Id of the linked email or memo, or empty when not linked. |
onlineFormFieldId | ID | Id of the online form field the file was uploaded into. |
onlineFormId | ID | Id of the linked online form submission. |
processId | ID | Id of the linked sales process. |
processTemplateId | ID | Id of the linked sales process template. |
projectId | ID | Id of the linked project. |
quoteId | ID | Id of the linked quote. |
reportScheduleId | ID | Id of the linked report schedule. |
textMessageId | ID | Id of the linked text message. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateCloudObjectRelationInput input 30 fields: clientMutationId, id, modified, …
Field values of a CloudObjectRelation 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. |
cloudObject | CreateCloudObjectInput | Cloud object (file) being linked. |
reportSchedule | CreateReportScheduleInput | Report schedule the file is attached to (e.g. an exported report). |
textMessage | CreateTextMessageInput | Text message (SMS/MMS) the file is attached to. |
accountId | ID | Id of the linked account. |
activityId | ID | Id of the linked appointment or task, or empty when not linked. |
approvalProcessId | ID | Id of the linked approval process. |
callId | ID | Id of the linked call. |
cloudObjectFolderId | ID | Id of the folder within the parent record, or empty when stored at the record root. |
cloudObjectId | ID | Id of the linked file. |
contactId | ID | Id of the linked contact. |
customEntityId | ID | Id of the linked custom entity record. |
emailSequenceId | ID | Id of the linked email sequence. |
emailTemplateId | ID | Id of the linked email template. |
fieldMappingId | ID | Id of the linked field mapping. |
leadOpptyId | ID | Id of the linked lead or opportunity, or empty when not linked. |
mediaId | ID | Id of the linked media record. |
messageId | ID | Id of the linked email or memo, or empty when not linked. |
onlineFormFieldId | ID | Id of the online form field the file was uploaded into. |
onlineFormId | ID | Id of the linked online form submission. |
processId | ID | Id of the linked sales process. |
processTemplateId | ID | Id of the linked sales process template. |
projectId | ID | Id of the linked project. |
quoteId | ID | Id of the linked quote. |
reportScheduleId | ID | Id of the linked report schedule. |
textMessageId | ID | Id of the linked text message. |
revision | Int | Revision when entity was lastly changed. |
DeleteCloudObjectRelationInput input 5 fields: clientMutationId, id, activityId, …
Id of the CloudObjectRelation 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. |
activityId | ID | Id of the linked appointment or task, or empty when not linked. |
leadOpptyId | ID | Id of the linked lead or opportunity, or empty when not linked. |
messageId | ID | Id of the linked email or memo, or empty when not linked. |
FieldMappingOrderByNestedInput input 6 fields: id, isDeleted, modified, …
Sorting by a field of the related FieldMapping record. Set exactly one field in each item.
| 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. |
isSystem | OrderByEnum | True when the mapping is shipped by the platform and cannot be deleted by the user. |
revision | OrderByEnum | Revision when entity was lastly changed. |
MediaOrderByNestedInput input 9 fields: id, isDeleted, modified, …
Sorting by a field of the related Media record. Set exactly one field in each item.
| 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. |
activityId | OrderByEnum | Id of the linked appointment or task, or empty when not linked to an activity. |
callId | OrderByEnum | Id of the linked call, or empty when not linked. |
description | OrderByEnum | Free-text description of the media. |
errorCode | OrderByEnum | Error code reported by the calling/recording provider when processing failed; empty on success. |
revision | OrderByEnum | Revision when entity was lastly changed. |
ProcessTemplateOrderByNestedInput input 9 fields: id, isDeleted, modified, …
Sorting by a field of the related ProcessTemplate record. Set exactly one field in each item.
| 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. |
description | OrderByEnum | Free-text description of what the template does. |
isRecommended | OrderByEnum | True when the platform recommends this template (highlighted in the template gallery). |
name | OrderByEnum | Name of the entity and its default text representation. |
triggerType | OrderByEnum | Kind of trigger pre-configured in the template, such as a record event (ProcessRecordTrigger) or a schedule (ProcessScheduleTrigger). Applied to any process created from this template. |
triggerEntityName | OrderByEnum | For record-based triggers in the template, the entity whose records would fire a spawned process (e.g. "Lead"). Empty for non-record triggers. |
TextMessageOrderByNestedInput input 12 fields: id, isDeleted, modified, …
Sorting by a field of the related TextMessage record. Set exactly one field in each item.
| 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. |
chatConversationId | OrderByEnum | Id of the AI assistant chat conversation this message belongs to, when applicable. |
content | OrderByEnum | Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). |
datetimeSent | OrderByEnum | Timestamp the message was sent. |
direction | OrderByEnum | Direction of the message (Incoming, Outgoing). |
messageSid | OrderByEnum | External message identifier from the SMS provider (e.g. Twilio Message SID). |
status | OrderByEnum | Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. |
textMessageConversationId | OrderByEnum | Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. |
revision | OrderByEnum | Revision when entity was lastly changed. |
UpdateCloudObjectRelationInput input 30 fields: clientMutationId, id, modified, …
Id of a CloudObjectRelation 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. |
cloudObject | CreateCloudObjectInput | Cloud object (file) being linked. |
reportSchedule | CreateReportScheduleInput | Report schedule the file is attached to (e.g. an exported report). |
textMessage | CreateTextMessageInput | Text message (SMS/MMS) the file is attached to. |
accountId | ID | Id of the linked account. |
activityId | ID | Id of the linked appointment or task, or empty when not linked. |
approvalProcessId | ID | Id of the linked approval process. |
callId | ID | Id of the linked call. |
cloudObjectFolderId | ID | Id of the folder within the parent record, or empty when stored at the record root. |
cloudObjectId | ID | Id of the linked file. |
contactId | ID | Id of the linked contact. |
customEntityId | ID | Id of the linked custom entity record. |
emailSequenceId | ID | Id of the linked email sequence. |
emailTemplateId | ID | Id of the linked email template. |
fieldMappingId | ID | Id of the linked field mapping. |
leadOpptyId | ID | Id of the linked lead or opportunity, or empty when not linked. |
mediaId | ID | Id of the linked media record. |
messageId | ID | Id of the linked email or memo, or empty when not linked. |
onlineFormFieldId | ID | Id of the online form field the file was uploaded into. |
onlineFormId | ID | Id of the linked online form submission. |
processId | ID | Id of the linked sales process. |
processTemplateId | ID | Id of the linked sales process template. |
projectId | ID | Id of the linked project. |
quoteId | ID | Id of the linked quote. |
reportScheduleId | ID | Id of the linked report schedule. |
textMessageId | ID | Id of the linked text message. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateCloudObjectRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateCloudObjectRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateCloudObjectRelationPayload object cloudObjectRelation: CloudObjectRelationEntity, clientMutationId: String
Result of the createCloudObjectRelation mutation.
| Field | Type | Description |
|---|---|---|
cloudObjectRelation | CloudObjectRelationEntity | 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). |
DeleteCloudObjectRelationPayload object cloudObjectRelation: CloudObjectRelationEntity, clientMutationId: String
Result of the deleteCloudObjectRelation mutation.
| Field | Type | Description |
|---|---|---|
cloudObjectRelation | CloudObjectRelationEntity | 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). |
UpdateCloudObjectRelationPayload object cloudObjectRelation: CloudObjectRelationEntity, clientMutationId: String
Result of the updateCloudObjectRelation mutation.
| Field | Type | Description |
|---|---|---|
cloudObjectRelation | CloudObjectRelationEntity | 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). |