GraphQL RepositoriescontactRelation

`entities.contactRelation`

Read contact relation records with the contactRelation repository, and change them with the contact relation mutations. Same records as the REST ContactRelations entity.

Example: first three contact relation recordsGraphQLcURL

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

Queries

Fields of entities { contactRelation { … } }.

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.	ContactRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ContactRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ContactRelationFilterInput, orderBy: [ContactRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ContactRelationEntity!]!
QUERY	`getByCriteria`(filter: ContactRelationFilterInput, orderBy: [ContactRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[ContactRelationEntity!]!
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	`createContactRelation`(input: CreateContactRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateContactRelationPayload
MUTATION	`updateContactRelation`(input: UpdateContactRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateContactRelationPayload
MUTATION	`bulkUpdateContactRelation`(input: [CreateOrUpdateContactRelationInput!]!, deleteInput: [DeleteContactRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateContactRelationPayload
MUTATION	`deleteContactRelation`(input: DeleteContactRelationInput!)	Soft-delete	DeleteContactRelationPayload

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.

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

Link between two related contacts, such as colleagues or family members; its labels give the kind of relationship.

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.
`contact1`	ContactEntity	One side of the contact-to-contact relationship.
`contact2`	ContactEntity	Other side of the contact-to-contact relationship.
`contact1Id`	ID!	Id of the first related contact.
`contact2Id`	ID!	Id of the second related contact.
`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.

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

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

Input field	Type	Description
`OR`	[ContactRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ContactRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ContactRelationFilterInput	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.
`contact1Id`	EntityFilterStringField	Id of the first related contact.
`contact2Id`	EntityFilterStringField	Id of the second related contact.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`contact1`	ContactFilterInput	One side of the contact-to-contact relationship. Matches records where a related record meets these conditions.
`contact2`	ContactFilterInput	Other side of the contact-to-contact relationship. Matches records where a related record meets these conditions.

ContactRelationOrderByInput input Asc or Desc per field

Sorting of ContactRelation 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.
`contact1`	[ContactOrderByNestedInput!]	One side of the contact-to-contact relationship. Sorts by fields of the related record, listed in order of priority.
`contact2`	[ContactOrderByNestedInput!]	Other side of the contact-to-contact relationship. Sorts by fields of the related record, listed in order of priority.
`contact1Id`	OrderByEnum	Id of the first related contact.
`contact2Id`	OrderByEnum	Id of the second related contact.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new ContactRelation 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.
`contact1Id`	ID!	Id of the first related contact.
`contact2Id`	ID!	Id of the second related contact.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a ContactRelation 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.
`contact1Id`	ID	Id of the first related contact.
`contact2Id`	ID	Id of the second related contact.
`revision`	Int	Revision when entity was lastly changed.

DeleteContactRelationInput input clientMutationId: String, id: ID!

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

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

Id of a ContactRelation 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.
`contact1Id`	ID	Id of the first related contact.
`contact2Id`	ID	Id of the second related contact.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateContactRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateContactRelation mutation.

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

CreateContactRelationPayload object contactRelation: ContactRelationEntity, clientMutationId: String

Result of the createContactRelation mutation.

Field	Type	Description
`contactRelation`	ContactRelationEntity	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).

DeleteContactRelationPayload object contactRelation: ContactRelationEntity, clientMutationId: String

Result of the deleteContactRelation mutation.

Field	Type	Description
`contactRelation`	ContactRelationEntity	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).

UpdateContactRelationPayload object contactRelation: ContactRelationEntity, clientMutationId: String

Result of the updateContactRelation mutation.

Field	Type	Description
`contactRelation`	ContactRelationEntity	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).