GraphQL RepositoriescontactAccountRelation

`entities.contactAccountRelation`

Read contact account relation records with the contactAccountRelation repository, and change them with the contact account relation mutations. Same records as the REST ContactAccountRelations entity.

Example: first three contact account relation recordsGraphQLcURL

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

Queries

Fields of entities { contactAccountRelation { … } }.

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.	ContactAccountRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ContactAccountRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ContactAccountRelationFilterInput, orderBy: [ContactAccountRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ContactAccountRelationEntity!]!
QUERY	`getByCriteria`(filter: ContactAccountRelationFilterInput, orderBy: [ContactAccountRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ContactAccountRelationEntityConnection
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	`createContactAccountRelation`(input: CreateContactAccountRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateContactAccountRelationPayload
MUTATION	`updateContactAccountRelation`(input: UpdateContactAccountRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateContactAccountRelationPayload
MUTATION	`bulkUpdateContactAccountRelation`(input: [CreateOrUpdateContactAccountRelationInput!]!, deleteInput: [DeleteContactAccountRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateContactAccountRelationPayload
MUTATION	`deleteContactAccountRelation`(input: DeleteContactAccountRelationInput!)	Soft-delete	DeleteContactAccountRelationPayload

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.

ContactAccountRelationEntity object 18 fields: isDeleteProtected, id, isDeleted, …

Link between a contact and an account they work for, with their position and their place in the account org chart.

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 contact is linked to.
`contact`	ContactEntity	Contact linked to the account.
`accountId`	ID!	Id of the account the contact is linked to.
`comment`	String	Free-form note describing this contact-account link.
`contactId`	ID!	Id of the contact linked to the account.
`isAssistant`	Boolean	True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
`isPrimary`	Boolean!	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`	Boolean	True when the contact is a sibling node on the account org chart (no parent/child reporting line).
`position`	String	Job title or position the contact holds at the account.
`relationship`	OrgRelationshipTypeEnum	Org-chart relationship of the contact within the account hierarchy.
`revision`	Int	Revision when entity was lastly changed.
`accountRoles`	[ContactAccountAccountRoleRelationEntity!]	Roles the contact holds within the linked account.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

ContactAccountRelationEntityConnection object pageInfo: PageInfo!, edges: [ContactAccountRelationEntityEdge]!, totalCount: Int

Paginated list of ContactAccountRelation records.

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

ContactAccountRelationEntityEdge object node: ContactAccountRelationEntity, cursor: String!

A Relay edge containing a ContactAccountRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ContactAccountRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ContactAccountRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ContactAccountRelationFilterInput	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 account the contact is linked to.
`comment`	EntityFilterStringField	Free-form note describing this contact-account link.
`contactId`	EntityFilterStringField	Id of the contact linked to the account.
`isAssistant`	Boolean	True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
`isPrimary`	Boolean	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`	Boolean	True when the contact is a sibling node on the account org chart (no parent/child reporting line).
`position`	EntityFilterStringField	Job title or position the contact holds at the account.
`relationship`	OrgRelationshipTypeEnumFilterInput	Org-chart relationship of the contact within the account hierarchy.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`account`	AccountFilterInput	Account the contact is linked to. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact linked to the account. Matches records where a related record meets these conditions.
`accountRoles`	ContactAccountAccountRoleRelationFilterInput	Roles the contact holds within the linked account. Matches records where a related record meets these conditions.

ContactAccountRelationOrderByInput input Asc or Desc per field

Sorting of ContactAccountRelation 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 contact is linked to. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact linked to the account. Sorts by fields of the related record, listed in order of priority.
`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.

CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput input modified: DateTime, created: DateTime, accountRoleId: ID!, revision: Int

Field values of a new ContactAccountAccountRoleRelation record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountRoleId`	ID!	Id of the role assigned to the contact at the account.
`revision`	Int	Revision when entity was lastly changed.

CreateContactAccountRelationInput input 13 fields: clientMutationId, modified, created, …

Field values of a new ContactAccountRelation 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.
`accountId`	ID!	Id of the account the contact is linked to.
`comment`	String	Free-form note describing this contact-account link.
`contactId`	ID!	Id of the contact linked to the account.
`isAssistant`	Boolean	True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
`isPrimary`	Boolean!	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`	Boolean	True when the contact is a sibling node on the account org chart (no parent/child reporting line).
`position`	String	Job title or position the contact holds at the account.
`relationship`	OrgRelationshipTypeEnum	Org-chart relationship of the contact within the account hierarchy.
`revision`	Int	Revision when entity was lastly changed.
`accountRoles`	[CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!]	Roles the contact holds within the linked account.

CreateOrUpdateContactAccountRelationInput input 14 fields: clientMutationId, id, modified, …

Field values of a ContactAccountRelation 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.
`accountId`	ID	Id of the account the contact is linked to.
`comment`	String	Free-form note describing this contact-account link.
`contactId`	ID	Id of the contact linked to the account.
`isAssistant`	Boolean	True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
`isPrimary`	Boolean	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`	Boolean	True when the contact is a sibling node on the account org chart (no parent/child reporting line).
`position`	String	Job title or position the contact holds at the account.
`relationship`	OrgRelationshipTypeEnum	Org-chart relationship of the contact within the account hierarchy.
`revision`	Int	Revision when entity was lastly changed.
`accountRoles`	[CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!]	Roles the contact holds within the linked account.

DeleteContactAccountRelationInput input clientMutationId: String, id: ID!

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

UpdateContactAccountRelationInput input 14 fields: clientMutationId, id, modified, …

Id of a ContactAccountRelation 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.
`accountId`	ID	Id of the account the contact is linked to.
`comment`	String	Free-form note describing this contact-account link.
`contactId`	ID	Id of the contact linked to the account.
`isAssistant`	Boolean	True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
`isPrimary`	Boolean	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`	Boolean	True when the contact is a sibling node on the account org chart (no parent/child reporting line).
`position`	String	Job title or position the contact holds at the account.
`relationship`	OrgRelationshipTypeEnum	Org-chart relationship of the contact within the account hierarchy.
`revision`	Int	Revision when entity was lastly changed.
`accountRoles`	[CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput!]	Roles the contact holds within the linked account.

BulkUpdateContactAccountRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateContactAccountRelation mutation.

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

CreateContactAccountRelationPayload object contactAccountRelation: ContactAccountRelationEntity, clientMutationId: String

Result of the createContactAccountRelation mutation.

Field	Type	Description
`contactAccountRelation`	ContactAccountRelationEntity	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).

DeleteContactAccountRelationPayload object contactAccountRelation: ContactAccountRelationEntity, clientMutationId: String

Result of the deleteContactAccountRelation mutation.

Field	Type	Description
`contactAccountRelation`	ContactAccountRelationEntity	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).

UpdateContactAccountRelationPayload object contactAccountRelation: ContactAccountRelationEntity, clientMutationId: String

Result of the updateContactAccountRelation mutation.

Field	Type	Description
`contactAccountRelation`	ContactAccountRelationEntity	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).