GraphQL RepositoriescontactRelationType

`entities.contactRelationType`

Read contact relation type records with the contactRelationType repository, and change them with the contact relation type mutations. Same records as the REST ContactRelationTypes entity.

Example: first three contact relation type recordsGraphQLcURL

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

Queries

Fields of entities { contactRelationType { … } }.

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.	ContactRelationTypeEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ContactRelationTypeEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ContactRelationTypeFilterInput, orderBy: [ContactRelationTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ContactRelationTypeEntity!]!
QUERY	`getByCriteria`(filter: ContactRelationTypeFilterInput, orderBy: [ContactRelationTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[ContactRelationTypeEntity!]!
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	`createContactRelationType`(input: CreateContactRelationTypeInput!, validationLevel: [ValidationLevel!])	Create one record	CreateContactRelationTypePayload
MUTATION	`updateContactRelationType`(input: UpdateContactRelationTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateContactRelationTypePayload
MUTATION	`bulkUpdateContactRelationType`(input: [CreateOrUpdateContactRelationTypeInput!]!, deleteInput: [DeleteContactRelationTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateContactRelationTypePayload
MUTATION	`deleteContactRelationType`(input: DeleteContactRelationTypeInput!)	Soft-delete	DeleteContactRelationTypePayload

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.

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

Kind of relationship that can be assigned to a link between two contacts, such as Spouse or Colleague, with its display color.

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.
`color`	Int!	Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String	Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
`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.

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

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

Input field	Type	Description
`OR`	[ContactRelationTypeFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ContactRelationTypeFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ContactRelationTypeFilterInput	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.
`color`	EntityFilterNumberField	Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	EntityFilterStringField	Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

ContactRelationTypeOrderByInput input Asc or Desc per field

Sorting of ContactRelationType 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.
`color`	OrderByEnum	Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	OrderByEnum	Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new ContactRelationType 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.
`color`	Int!	Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String	Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a ContactRelationType 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.
`color`	Int	Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String	Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
`revision`	Int	Revision when entity was lastly changed.

DeleteContactRelationTypeInput input clientMutationId: String, id: ID!

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

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

Id of a ContactRelationType 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.
`color`	Int	Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String	Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateContactRelationTypePayload object result: BulkUpdateResults!

Result of the bulkUpdateContactRelationType mutation.

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

CreateContactRelationTypePayload object contactRelationType: ContactRelationTypeEntity, clientMutationId: String

Result of the createContactRelationType mutation.

Field	Type	Description
`contactRelationType`	ContactRelationTypeEntity	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).

DeleteContactRelationTypePayload object contactRelationType: ContactRelationTypeEntity, clientMutationId: String

Result of the deleteContactRelationType mutation.

Field	Type	Description
`contactRelationType`	ContactRelationTypeEntity	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).

UpdateContactRelationTypePayload object contactRelationType: ContactRelationTypeEntity, clientMutationId: String

Result of the updateContactRelationType mutation.

Field	Type	Description
`contactRelationType`	ContactRelationTypeEntity	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).