GraphQLRepositoriescontactAccountAccountRoleRelation
entities.contactAccountAccountRoleRelation
Read contact account account role relation records with the contactAccountAccountRoleRelation repository, and change them with the contact account account role relation mutations. Same records as the REST ContactAccountAccountRoleRelations entity.
Queries
Fields of entities { contactAccountAccountRoleRelation { … } }.
| 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. | ContactAccountAccountRoleRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [ContactAccountAccountRoleRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: ContactAccountAccountRoleRelationFilterInput, orderBy: [ContactAccountAccountRoleRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [ContactAccountAccountRoleRelationEntity!]! |
| QUERY | getByCriteria(filter: ContactAccountAccountRoleRelationFilterInput, orderBy: [ContactAccountAccountRoleRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | ContactAccountAccountRoleRelationEntityConnection |
| 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 | createContactAccountAccountRoleRelation(input: CreateContactAccountAccountRoleRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateContactAccountAccountRoleRelationPayload |
| MUTATION | updateContactAccountAccountRoleRelation(input: UpdateContactAccountAccountRoleRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateContactAccountAccountRoleRelationPayload |
| MUTATION | bulkUpdateContactAccountAccountRoleRelation(input: [CreateOrUpdateContactAccountAccountRoleRelationInput!]!, deleteInput: [DeleteContactAccountAccountRoleRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateContactAccountAccountRoleRelationPayload |
| MUTATION | deleteContactAccountAccountRoleRelation(input: DeleteContactAccountAccountRoleRelationInput!) | Soft-delete | DeleteContactAccountAccountRoleRelationPayload |
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.
ContactAccountAccountRoleRelationEntity object 11 fields: isDeleteProtected, id, isDeleted, …
Role assigned to a contact at an account, on the link between the contact and the account.
| 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. |
accountRole | AccountRoleEntity | Role assigned to the contact at the account. |
contactAccountRelation | ContactAccountRelationEntity | Contact-account link this role assignment belongs to. |
accountRoleId | ID! | Id of the role assigned to the contact at the account. |
contactAccountRelationId | ID! | Id of the contact-account link. |
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. |
ContactAccountAccountRoleRelationEntityConnection object pageInfo: PageInfo!, edges: [ContactAccountAccountRoleRelationEntityEdge]!, totalCount: Int
Paginated list of ContactAccountAccountRoleRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [ContactAccountAccountRoleRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
ContactAccountAccountRoleRelationEntityEdge object node: ContactAccountAccountRoleRelationEntity, cursor: String!
A Relay edge containing a ContactAccountAccountRoleRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | ContactAccountAccountRoleRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
ContactAccountAccountRoleRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for ContactAccountAccountRoleRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [ContactAccountAccountRoleRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [ContactAccountAccountRoleRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | ContactAccountAccountRoleRelationFilterInput | 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. |
accountRoleId | EntityFilterStringField | Id of the role assigned to the contact at the account. |
contactAccountRelationId | EntityFilterStringField | Id of the contact-account link. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
accountRole | AccountRoleFilterInput | Role assigned to the contact at the account. Matches records where a related record meets these conditions. |
contactAccountRelation | ContactAccountRelationFilterInput | Contact-account link this role assignment belongs to. Matches records where a related record meets these conditions. |
ContactAccountAccountRoleRelationOrderByInput input Asc or Desc per field
Sorting of ContactAccountAccountRoleRelation 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. |
accountRole | [AccountRoleOrderByNestedInput!] | Role assigned to the contact at the account. Sorts by fields of the related record, listed in order of priority. |
contactAccountRelation | [ContactAccountRelationOrderByNestedInput!] | Contact-account link this role assignment belongs to. Sorts by fields of the related record, listed in order of priority. |
accountRoleId | OrderByEnum | Id of the role assigned to the contact at the account. |
contactAccountRelationId | OrderByEnum | Id of the contact-account link. |
revision | OrderByEnum | Revision when entity was lastly changed. |
ContactAccountRelationOrderByNestedInput input 13 fields: id, isDeleted, modified, …
Sorting by a field of the related ContactAccountRelation 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. |
accountId | OrderByEnum | Id of the account the contact is linked to. |
comment | OrderByEnum | Free-form note describing this contact-account link. |
contactId | OrderByEnum | Id of the contact linked to the account. |
isAssistant | OrderByEnum | True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations. |
isPrimary | OrderByEnum | True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row. |
isSibling | OrderByEnum | True when the contact is a sibling node on the account org chart (no parent/child reporting line). |
position | OrderByEnum | Job title or position the contact holds at the account. |
relationship | OrderByEnum | Org-chart relationship of the contact within the account hierarchy. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateContactAccountAccountRoleRelationInput input 7 fields: clientMutationId, modified, created, …
Field values of a new ContactAccountAccountRoleRelation 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. |
contactAccountRelation | CreateContactAccountRelationInput! | Contact-account link this role assignment belongs to. |
accountRoleId | ID! | Id of the role assigned to the contact at the account. |
contactAccountRelationId | ID! | Id of the contact-account link. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateContactAccountAccountRoleRelationInput input 8 fields: clientMutationId, id, modified, …
Field values of a ContactAccountAccountRoleRelation 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. |
contactAccountRelation | CreateContactAccountRelationInput | Contact-account link this role assignment belongs to. |
accountRoleId | ID | Id of the role assigned to the contact at the account. |
contactAccountRelationId | ID | Id of the contact-account link. |
revision | Int | Revision when entity was lastly changed. |
DeleteContactAccountAccountRoleRelationInput input clientMutationId: String, id: ID!
Id of the ContactAccountAccountRoleRelation 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. |
UpdateContactAccountAccountRoleRelationInput input 8 fields: clientMutationId, id, modified, …
Id of a ContactAccountAccountRoleRelation 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. |
contactAccountRelation | CreateContactAccountRelationInput | Contact-account link this role assignment belongs to. |
accountRoleId | ID | Id of the role assigned to the contact at the account. |
contactAccountRelationId | ID | Id of the contact-account link. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateContactAccountAccountRoleRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateContactAccountAccountRoleRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateContactAccountAccountRoleRelationPayload object contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationEntity, clientMutationId: String
Result of the createContactAccountAccountRoleRelation mutation.
| Field | Type | Description |
|---|---|---|
contactAccountAccountRoleRelation | ContactAccountAccountRoleRelationEntity | 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). |
DeleteContactAccountAccountRoleRelationPayload object contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationEntity, clientMutationId: String
Result of the deleteContactAccountAccountRoleRelation mutation.
| Field | Type | Description |
|---|---|---|
contactAccountAccountRoleRelation | ContactAccountAccountRoleRelationEntity | 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). |
UpdateContactAccountAccountRoleRelationPayload object contactAccountAccountRoleRelation: ContactAccountAccountRoleRelationEntity, clientMutationId: String
Result of the updateContactAccountAccountRoleRelation mutation.
| Field | Type | Description |
|---|---|---|
contactAccountAccountRoleRelation | ContactAccountAccountRoleRelationEntity | 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). |