GraphQL RepositoriesghostContact

`entities.ghostContact`

Read ghost contact records with the ghostContact repository, and change them with the ghost contact mutations. Same records as the REST GhostContacts entity.

Example: first three ghost contact recordsGraphQLcURL

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

Queries

Fields of entities { ghostContact { … } }.

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.	GhostContactEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[GhostContactEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: GhostContactFilterInput, orderBy: [GhostContactOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[GhostContactEntity!]!
QUERY	`getByCriteria`(filter: GhostContactFilterInput, orderBy: [GhostContactOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	GhostContactEntityConnection
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	`createGhostContact`(input: CreateGhostContactInput!, validationLevel: [ValidationLevel!])	Create one record	CreateGhostContactPayload
MUTATION	`updateGhostContact`(input: UpdateGhostContactInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateGhostContactPayload
MUTATION	`bulkUpdateGhostContact`(input: [CreateOrUpdateGhostContactInput!]!, deleteInput: [DeleteGhostContactInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateGhostContactPayload
MUTATION	`deleteGhostContact`(input: DeleteGhostContactInput!)	Soft-delete	DeleteGhostContactPayload

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.

GhostContactEntity object 9 fields: isDeleteProtected, id, isDeleted, …

Placeholder person on an org chart for someone who is not a contact in the space yet, such as an unknown decision maker.

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.
`name`	String!	Name of the entity and its default text representation.
`position`	String	Job title or position of the placeholder contact (org-chart label).
`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.

GhostContactEntityConnection object pageInfo: PageInfo!, edges: [GhostContactEntityEdge]!, totalCount: Int

Paginated list of GhostContact records.

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

GhostContactEntityEdge object node: GhostContactEntity, cursor: String!

A Relay edge containing a GhostContactEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[GhostContactFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[GhostContactFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	GhostContactFilterInput	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.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`position`	EntityFilterStringField	Job title or position of the placeholder contact (org-chart label).
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

GhostContactOrderByInput input Asc or Desc per field

Sorting of GhostContact 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.
`name`	OrderByEnum	Name of the entity and its default text representation.
`position`	OrderByEnum	Job title or position of the placeholder contact (org-chart label).
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateGhostContactInput input 6 fields: clientMutationId, modified, created, …

Field values of a new GhostContact 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.
`name`	String!	Name of the entity and its default text representation.
`position`	String	Job title or position of the placeholder contact (org-chart label).
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateGhostContactInput input 7 fields: clientMutationId, id, modified, …

Field values of a GhostContact 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.
`name`	String	Name of the entity and its default text representation.
`position`	String	Job title or position of the placeholder contact (org-chart label).
`revision`	Int	Revision when entity was lastly changed.

DeleteGhostContactInput input clientMutationId: String, id: ID!

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

UpdateGhostContactInput input 7 fields: clientMutationId, id, modified, …

Id of a GhostContact 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.
`name`	String	Name of the entity and its default text representation.
`position`	String	Job title or position of the placeholder contact (org-chart label).
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateGhostContactPayload object result: BulkUpdateResults!

Result of the bulkUpdateGhostContact mutation.

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

CreateGhostContactPayload object ghostContact: GhostContactEntity, clientMutationId: String

Result of the createGhostContact mutation.

Field	Type	Description
`ghostContact`	GhostContactEntity	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).

DeleteGhostContactPayload object ghostContact: GhostContactEntity, clientMutationId: String

Result of the deleteGhostContact mutation.

Field	Type	Description
`ghostContact`	GhostContactEntity	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).

UpdateGhostContactPayload object ghostContact: GhostContactEntity, clientMutationId: String

Result of the updateGhostContact mutation.

Field	Type	Description
`ghostContact`	GhostContactEntity	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).