GraphQLRepositoriesghostContactAccountRelation
entities.ghostContactAccountRelation
Read ghost contact account relation records with the ghostContactAccountRelation repository, and change them with the ghost contact account relation mutations. Same records as the REST GhostContactAccountRelations entity.
Queries
Fields of entities { ghostContactAccountRelation { … } }.
| 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. | GhostContactAccountRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [GhostContactAccountRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: GhostContactAccountRelationFilterInput, orderBy: [GhostContactAccountRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [GhostContactAccountRelationEntity!]! |
| QUERY | getByCriteria(filter: GhostContactAccountRelationFilterInput, orderBy: [GhostContactAccountRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | GhostContactAccountRelationEntityConnection |
| 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 | createGhostContactAccountRelation(input: CreateGhostContactAccountRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateGhostContactAccountRelationPayload |
| MUTATION | updateGhostContactAccountRelation(input: UpdateGhostContactAccountRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateGhostContactAccountRelationPayload |
| MUTATION | bulkUpdateGhostContactAccountRelation(input: [CreateOrUpdateGhostContactAccountRelationInput!]!, deleteInput: [DeleteGhostContactAccountRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateGhostContactAccountRelationPayload |
| MUTATION | deleteGhostContactAccountRelation(input: DeleteGhostContactAccountRelationInput!) | Soft-delete | DeleteGhostContactAccountRelationPayload |
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.
GhostContactAccountRelationEntity object 16 fields: isDeleteProtected, id, isDeleted, …
Placement of a ghost contact on the org chart of an account, with its position and comment.
| 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 whose org chart includes the ghost contact. |
ghostContact | GhostContactEntity | Placeholder ghost contact placed on the account org chart. |
accountId | ID! | Id of the account whose org chart includes the ghost contact. |
comment | String | Free-text comment shown on the org-chart node. |
ghostContactId | ID! | Id of the ghost contact placed on the account org chart. |
isAssistant | Boolean | True when the ghost contact is rendered as an assistant of its parent in the org chart. |
isSibling | Boolean | True when the ghost contact is rendered as a sibling rather than a child in the org chart. |
position | String | Position label shown on the org chart for the ghost contact. |
revision | Int | Revision when entity was lastly changed. |
accountRoles | GhostContactAccountAccountRoleRelationEntityConnection (8 args) | Account roles assigned to the ghost contact on this account. |
instancePermissions | [EntityPermsEnum!]! (1 args) | Permissions the current user has on this record, out of the requested ones. |
GhostContactAccountRelationEntityConnection object pageInfo: PageInfo!, edges: [GhostContactAccountRelationEntityEdge]!, totalCount: Int
Paginated list of GhostContactAccountRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [GhostContactAccountRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
GhostContactAccountRelationEntityEdge object node: GhostContactAccountRelationEntity, cursor: String!
A Relay edge containing a GhostContactAccountRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | GhostContactAccountRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
GhostContactAccountRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for GhostContactAccountRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [GhostContactAccountRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [GhostContactAccountRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | GhostContactAccountRelationFilterInput | 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 whose org chart includes the ghost contact. |
comment | EntityFilterStringField | Free-text comment shown on the org-chart node. |
ghostContactId | EntityFilterStringField | Id of the ghost contact placed on the account org chart. |
isAssistant | Boolean | True when the ghost contact is rendered as an assistant of its parent in the org chart. |
isSibling | Boolean | True when the ghost contact is rendered as a sibling rather than a child in the org chart. |
position | EntityFilterStringField | Position label shown on the org chart for the ghost contact. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
account | AccountFilterInput | Account whose org chart includes the ghost contact. Matches records where a related record meets these conditions. |
ghostContact | GhostContactFilterInput | Placeholder ghost contact placed on the account org chart. Matches records where a related record meets these conditions. |
accountRoles | GhostContactAccountAccountRoleRelationFilterInput | Account roles assigned to the ghost contact on this account. Matches records where a related record meets these conditions. |
GhostContactAccountRelationOrderByInput input Asc or Desc per field
Sorting of GhostContactAccountRelation 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 whose org chart includes the ghost contact. Sorts by fields of the related record, listed in order of priority. |
ghostContact | [GhostContactOrderByNestedInput!] | Placeholder ghost contact placed on the account org chart. Sorts by fields of the related record, listed in order of priority. |
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. |
CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput input modified: DateTime, created: DateTime, accountRoleId: ID!, revision: Int
Field values of a new GhostContactAccountAccountRoleRelation 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 account role assigned to the ghost contact. |
revision | Int | Revision when entity was lastly changed. |
CreateGhostContactAccountRelationInput input 12 fields: clientMutationId, modified, created, …
Field values of a new GhostContactAccountRelation 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. |
ghostContact | CreateGhostContactInput! | Placeholder ghost contact placed on the account org chart. |
accountId | ID! | Id of the account whose org chart includes the ghost contact. |
comment | String | Free-text comment shown on the org-chart node. |
ghostContactId | ID! | Id of the ghost contact placed on the account org chart. |
isAssistant | Boolean | True when the ghost contact is rendered as an assistant of its parent in the org chart. |
isSibling | Boolean | True when the ghost contact is rendered as a sibling rather than a child in the org chart. |
position | String | Position label shown on the org chart for the ghost contact. |
revision | Int | Revision when entity was lastly changed. |
accountRoles | [CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput!] | Account roles assigned to the ghost contact on this account. |
CreateOrUpdateGhostContactAccountRelationInput input 13 fields: clientMutationId, id, modified, …
Field values of a GhostContactAccountRelation 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. |
ghostContact | CreateGhostContactInput | Placeholder ghost contact placed on the account org chart. |
accountId | ID | Id of the account whose org chart includes the ghost contact. |
comment | String | Free-text comment shown on the org-chart node. |
ghostContactId | ID | Id of the ghost contact placed on the account org chart. |
isAssistant | Boolean | True when the ghost contact is rendered as an assistant of its parent in the org chart. |
isSibling | Boolean | True when the ghost contact is rendered as a sibling rather than a child in the org chart. |
position | String | Position label shown on the org chart for the ghost contact. |
revision | Int | Revision when entity was lastly changed. |
accountRoles | [CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput!] | Account roles assigned to the ghost contact on this account. |
DeleteGhostContactAccountRelationInput input clientMutationId: String, id: ID!
Id of the GhostContactAccountRelation 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. |
UpdateGhostContactAccountRelationInput input 13 fields: clientMutationId, id, modified, …
Id of a GhostContactAccountRelation 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. |
ghostContact | CreateGhostContactInput | Placeholder ghost contact placed on the account org chart. |
accountId | ID | Id of the account whose org chart includes the ghost contact. |
comment | String | Free-text comment shown on the org-chart node. |
ghostContactId | ID | Id of the ghost contact placed on the account org chart. |
isAssistant | Boolean | True when the ghost contact is rendered as an assistant of its parent in the org chart. |
isSibling | Boolean | True when the ghost contact is rendered as a sibling rather than a child in the org chart. |
position | String | Position label shown on the org chart for the ghost contact. |
revision | Int | Revision when entity was lastly changed. |
accountRoles | [CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput!] | Account roles assigned to the ghost contact on this account. |
BulkUpdateGhostContactAccountRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateGhostContactAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateGhostContactAccountRelationPayload object ghostContactAccountRelation: GhostContactAccountRelationEntity, clientMutationId: String
Result of the createGhostContactAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
ghostContactAccountRelation | GhostContactAccountRelationEntity | 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). |
DeleteGhostContactAccountRelationPayload object ghostContactAccountRelation: GhostContactAccountRelationEntity, clientMutationId: String
Result of the deleteGhostContactAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
ghostContactAccountRelation | GhostContactAccountRelationEntity | 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). |
UpdateGhostContactAccountRelationPayload object ghostContactAccountRelation: GhostContactAccountRelationEntity, clientMutationId: String
Result of the updateGhostContactAccountRelation mutation.
| Field | Type | Description |
|---|---|---|
ghostContactAccountRelation | GhostContactAccountRelationEntity | 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). |