GraphQL RepositoriescontactRelationLabel

`entities.contactRelationLabel`

Read contact relation label records with the contactRelationLabel repository, and change them with the contact relation label mutations. Same records as the REST ContactRelationLabels entity.

Example: first three contact relation label recordsGraphQLcURL

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

Queries

Fields of entities { contactRelationLabel { … } }.

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.	ContactRelationLabelEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ContactRelationLabelEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ContactRelationLabelFilterInput, orderBy: [ContactRelationLabelOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ContactRelationLabelEntity!]!
QUERY	`getByCriteria`(filter: ContactRelationLabelFilterInput, orderBy: [ContactRelationLabelOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[ContactRelationLabelEntity!]!
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	`createContactRelationLabel`(input: CreateContactRelationLabelInput!, validationLevel: [ValidationLevel!])	Create one record	CreateContactRelationLabelPayload
MUTATION	`updateContactRelationLabel`(input: UpdateContactRelationLabelInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateContactRelationLabelPayload
MUTATION	`bulkUpdateContactRelationLabel`(input: [CreateOrUpdateContactRelationLabelInput!]!, deleteInput: [DeleteContactRelationLabelInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateContactRelationLabelPayload
MUTATION	`deleteContactRelationLabel`(input: DeleteContactRelationLabelInput!)	Soft-delete	DeleteContactRelationLabelPayload

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.

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

Relationship type assigned to a link between two contacts, such as Spouse or Colleague.

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.
`contactRelation`	ContactRelationEntity	Contact relationship being labelled.
`contactRelationType`	ContactRelationTypeEntity	Type of the relationship (e.g. spouse, colleague).
`contactRelationId`	ID!	Id of the contact relationship.
`contactRelationTypeId`	ID!	Id of the relationship type.
`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.

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

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

Input field	Type	Description
`OR`	[ContactRelationLabelFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ContactRelationLabelFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ContactRelationLabelFilterInput	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.
`contactRelationId`	EntityFilterStringField	Id of the contact relationship.
`contactRelationTypeId`	EntityFilterStringField	Id of the relationship type.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`contactRelation`	ContactRelationFilterInput	Contact relationship being labelled. Matches records where a related record meets these conditions.
`contactRelationType`	ContactRelationTypeFilterInput	Type of the relationship (e.g. spouse, colleague). Matches records where a related record meets these conditions.

ContactRelationLabelOrderByInput input Asc or Desc per field

Sorting of ContactRelationLabel 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.
`contactRelation`	[ContactRelationOrderByNestedInput!]	Contact relationship being labelled. Sorts by fields of the related record, listed in order of priority.
`contactRelationType`	[ContactRelationTypeOrderByNestedInput!]	Type of the relationship (e.g. spouse, colleague). Sorts by fields of the related record, listed in order of priority.
`contactRelationId`	OrderByEnum	Id of the contact relationship.
`contactRelationTypeId`	OrderByEnum	Id of the relationship type.
`revision`	OrderByEnum	Revision when entity was lastly changed.

ContactRelationOrderByNestedInput input 7 fields: id, isDeleted, modified, …

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

ContactRelationTypeOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related ContactRelationType 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.
`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.

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

Field values of a new ContactRelationLabel 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.
`contactRelation`	CreateContactRelationInput!	Contact relationship being labelled.
`contactRelationId`	ID!	Id of the contact relationship.
`contactRelationTypeId`	ID!	Id of the relationship type.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a ContactRelationLabel 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.
`contactRelation`	CreateContactRelationInput	Contact relationship being labelled.
`contactRelationId`	ID	Id of the contact relationship.
`contactRelationTypeId`	ID	Id of the relationship type.
`revision`	Int	Revision when entity was lastly changed.

DeleteContactRelationLabelInput input clientMutationId: String, id: ID!

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

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

Id of a ContactRelationLabel 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.
`contactRelation`	CreateContactRelationInput	Contact relationship being labelled.
`contactRelationId`	ID	Id of the contact relationship.
`contactRelationTypeId`	ID	Id of the relationship type.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateContactRelationLabelPayload object result: BulkUpdateResults!

Result of the bulkUpdateContactRelationLabel mutation.

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

CreateContactRelationLabelPayload object contactRelationLabel: ContactRelationLabelEntity, clientMutationId: String

Result of the createContactRelationLabel mutation.

Field	Type	Description
`contactRelationLabel`	ContactRelationLabelEntity	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).

DeleteContactRelationLabelPayload object contactRelationLabel: ContactRelationLabelEntity, clientMutationId: String

Result of the deleteContactRelationLabel mutation.

Field	Type	Description
`contactRelationLabel`	ContactRelationLabelEntity	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).

UpdateContactRelationLabelPayload object contactRelationLabel: ContactRelationLabelEntity, clientMutationId: String

Result of the updateContactRelationLabel mutation.

Field	Type	Description
`contactRelationLabel`	ContactRelationLabelEntity	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).