GraphQL RepositoriesghostContactAccountAccountRoleRelation

`entities.ghostContactAccountAccountRoleRelation`

Read ghost contact account account role relation records with the ghostContactAccountAccountRoleRelation repository, and change them with the ghost contact account account role relation mutations. Same records as the REST GhostContactAccountAccountRoleRelations entity.

Example: first three ghost contact account account role relation recordsGraphQLcURL

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

Queries

Fields of entities { ghostContactAccountAccountRoleRelation { … } }.

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.	GhostContactAccountAccountRoleRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[GhostContactAccountAccountRoleRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: GhostContactAccountAccountRoleRelationFilterInput, orderBy: [GhostContactAccountAccountRoleRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[GhostContactAccountAccountRoleRelationEntity!]!
QUERY	`getByCriteria`(filter: GhostContactAccountAccountRoleRelationFilterInput, orderBy: [GhostContactAccountAccountRoleRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	GhostContactAccountAccountRoleRelationEntityConnection
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	`createGhostContactAccountAccountRoleRelation`(input: CreateGhostContactAccountAccountRoleRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateGhostContactAccountAccountRoleRelationPayload
MUTATION	`updateGhostContactAccountAccountRoleRelation`(input: UpdateGhostContactAccountAccountRoleRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateGhostContactAccountAccountRoleRelationPayload
MUTATION	`bulkUpdateGhostContactAccountAccountRoleRelation`(input: [CreateOrUpdateGhostContactAccountAccountRoleRelationInput!]!, deleteInput: [DeleteGhostContactAccountAccountRoleRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateGhostContactAccountAccountRoleRelationPayload
MUTATION	`deleteGhostContactAccountAccountRoleRelation`(input: DeleteGhostContactAccountAccountRoleRelationInput!)	Soft-delete	DeleteGhostContactAccountAccountRoleRelationPayload

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.

GhostContactAccountAccountRoleRelationEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Role assigned to a ghost contact on the org chart of an 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	Account role assigned to the ghost contact.
`ghostContactAccountRelation`	GhostContactAccountRelationEntity	Ghost-contact-on-account placement this role assignment belongs to.
`accountRoleId`	ID!	Id of the account role assigned to the ghost contact.
`ghostContactAccountRelationId`	ID!	Id of the ghost-contact-account placement.
`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.

GhostContactAccountAccountRoleRelationEntityConnection object pageInfo: PageInfo!, edges: [GhostContactAccountAccountRoleRelationEntityEdge]!, totalCount: Int

Paginated list of GhostContactAccountAccountRoleRelation records.

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

GhostContactAccountAccountRoleRelationEntityEdge object node: GhostContactAccountAccountRoleRelationEntity, cursor: String!

A Relay edge containing a GhostContactAccountAccountRoleRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[GhostContactAccountAccountRoleRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[GhostContactAccountAccountRoleRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	GhostContactAccountAccountRoleRelationFilterInput	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 account role assigned to the ghost contact.
`ghostContactAccountRelationId`	EntityFilterStringField	Id of the ghost-contact-account placement.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`accountRole`	AccountRoleFilterInput	Account role assigned to the ghost contact. Matches records where a related record meets these conditions.
`ghostContactAccountRelation`	GhostContactAccountRelationFilterInput	Ghost-contact-on-account placement this role assignment belongs to. Matches records where a related record meets these conditions.

GhostContactAccountAccountRoleRelationOrderByInput input Asc or Desc per field

Sorting of GhostContactAccountAccountRoleRelation 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!]	Account role assigned to the ghost contact. Sorts by fields of the related record, listed in order of priority.
`ghostContactAccountRelation`	[GhostContactAccountRelationOrderByNestedInput!]	Ghost-contact-on-account placement this role assignment belongs to. Sorts by fields of the related record, listed in order of priority.
`accountRoleId`	OrderByEnum	Id of the account role assigned to the ghost contact.
`ghostContactAccountRelationId`	OrderByEnum	Id of the ghost-contact-account placement.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateGhostContactAccountAccountRoleRelationInput input 7 fields: clientMutationId, modified, created, …

Field values of a new GhostContactAccountAccountRoleRelation 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.
`ghostContactAccountRelation`	CreateGhostContactAccountRelationInput!	Ghost-contact-on-account placement this role assignment belongs to.
`accountRoleId`	ID!	Id of the account role assigned to the ghost contact.
`ghostContactAccountRelationId`	ID!	Id of the ghost-contact-account placement.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateGhostContactAccountAccountRoleRelationInput input 8 fields: clientMutationId, id, modified, …

Field values of a GhostContactAccountAccountRoleRelation 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.
`ghostContactAccountRelation`	CreateGhostContactAccountRelationInput	Ghost-contact-on-account placement this role assignment belongs to.
`accountRoleId`	ID	Id of the account role assigned to the ghost contact.
`ghostContactAccountRelationId`	ID	Id of the ghost-contact-account placement.
`revision`	Int	Revision when entity was lastly changed.

DeleteGhostContactAccountAccountRoleRelationInput input clientMutationId: String, id: ID!

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

GhostContactAccountRelationOrderByNestedInput input 11 fields: id, isDeleted, modified, …

Sorting by a field of the related GhostContactAccountRelation 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 whose org chart includes the ghost contact.
`comment`	OrderByEnum	Free-text comment shown on the org-chart node.
`ghostContactId`	OrderByEnum	Id of the ghost contact placed on the account org chart.
`isAssistant`	OrderByEnum	True when the ghost contact is rendered as an assistant of its parent in the org chart.
`isSibling`	OrderByEnum	True when the ghost contact is rendered as a sibling rather than a child in the org chart.
`position`	OrderByEnum	Position label shown on the org chart for the ghost contact.
`revision`	OrderByEnum	Revision when entity was lastly changed.

UpdateGhostContactAccountAccountRoleRelationInput input 8 fields: clientMutationId, id, modified, …

Id of a GhostContactAccountAccountRoleRelation 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.
`ghostContactAccountRelation`	CreateGhostContactAccountRelationInput	Ghost-contact-on-account placement this role assignment belongs to.
`accountRoleId`	ID	Id of the account role assigned to the ghost contact.
`ghostContactAccountRelationId`	ID	Id of the ghost-contact-account placement.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateGhostContactAccountAccountRoleRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateGhostContactAccountAccountRoleRelation mutation.

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

CreateGhostContactAccountAccountRoleRelationPayload object ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationEntity, clientMutationId: String

Result of the createGhostContactAccountAccountRoleRelation mutation.

Field	Type	Description
`ghostContactAccountAccountRoleRelation`	GhostContactAccountAccountRoleRelationEntity	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).

DeleteGhostContactAccountAccountRoleRelationPayload object ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationEntity, clientMutationId: String

Result of the deleteGhostContactAccountAccountRoleRelation mutation.

Field	Type	Description
`ghostContactAccountAccountRoleRelation`	GhostContactAccountAccountRoleRelationEntity	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).

UpdateGhostContactAccountAccountRoleRelationPayload object ghostContactAccountAccountRoleRelation: GhostContactAccountAccountRoleRelationEntity, clientMutationId: String

Result of the updateGhostContactAccountAccountRoleRelation mutation.

Field	Type	Description
`ghostContactAccountAccountRoleRelation`	GhostContactAccountAccountRoleRelationEntity	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).