GraphQL RepositoriesaccountRelationLabel

`entities.accountRelationLabel`

Read account relation label records with the accountRelationLabel repository, and change them with the account relation label mutations. Same records as the REST AccountRelationLabels entity.

Example: first three account relation label recordsGraphQLcURL

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

Queries

Fields of entities { accountRelationLabel { … } }.

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.	AccountRelationLabelEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AccountRelationLabelEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AccountRelationLabelFilterInput, orderBy: [AccountRelationLabelOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AccountRelationLabelEntity!]!
QUERY	`getByCriteria`(filter: AccountRelationLabelFilterInput, orderBy: [AccountRelationLabelOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[AccountRelationLabelEntity!]!
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	`createAccountRelationLabel`(input: CreateAccountRelationLabelInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAccountRelationLabelPayload
MUTATION	`updateAccountRelationLabel`(input: UpdateAccountRelationLabelInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAccountRelationLabelPayload
MUTATION	`bulkUpdateAccountRelationLabel`(input: [CreateOrUpdateAccountRelationLabelInput!]!, deleteInput: [DeleteAccountRelationLabelInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAccountRelationLabelPayload
MUTATION	`deleteAccountRelationLabel`(input: DeleteAccountRelationLabelInput!)	Soft-delete	DeleteAccountRelationLabelPayload

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.

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

Relationship type assigned to a link between two accounts, such as Partner or Supplier.

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.
`accountRelation`	AccountRelationEntity	Account relationship being labelled.
`accountRelationType`	AccountRelationTypeEntity	Type of the relationship (e.g. partner, supplier).
`accountRelationId`	ID!	Id of the account relationship.
`accountRelationTypeId`	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.

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

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

Input field	Type	Description
`OR`	[AccountRelationLabelFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AccountRelationLabelFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AccountRelationLabelFilterInput	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.
`accountRelationId`	EntityFilterStringField	Id of the account relationship.
`accountRelationTypeId`	EntityFilterStringField	Id of the relationship type.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`accountRelation`	AccountRelationFilterInput	Account relationship being labelled. Matches records where a related record meets these conditions.
`accountRelationType`	AccountRelationTypeFilterInput	Type of the relationship (e.g. partner, supplier). Matches records where a related record meets these conditions.

AccountRelationLabelOrderByInput input Asc or Desc per field

Sorting of AccountRelationLabel 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.
`accountRelation`	[AccountRelationOrderByNestedInput!]	Account relationship being labelled. Sorts by fields of the related record, listed in order of priority.
`accountRelationType`	[AccountRelationTypeOrderByNestedInput!]	Type of the relationship (e.g. partner, supplier). Sorts by fields of the related record, listed in order of priority.
`accountRelationId`	OrderByEnum	Id of the account relationship.
`accountRelationTypeId`	OrderByEnum	Id of the relationship type.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Sorting by a field of the related AccountRelation 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.
`account1Id`	OrderByEnum	Id of the first related account.
`account2Id`	OrderByEnum	Id of the second related account.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Sorting by a field of the related AccountRelationType 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 account-to-account relationship type (e.g. Partner, Supplier).
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new AccountRelationLabel 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.
`accountRelation`	CreateAccountRelationInput!	Account relationship being labelled.
`accountRelationId`	ID!	Id of the account relationship.
`accountRelationTypeId`	ID!	Id of the relationship type.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an AccountRelationLabel 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.
`accountRelation`	CreateAccountRelationInput	Account relationship being labelled.
`accountRelationId`	ID	Id of the account relationship.
`accountRelationTypeId`	ID	Id of the relationship type.
`revision`	Int	Revision when entity was lastly changed.

DeleteAccountRelationLabelInput input clientMutationId: String, id: ID!

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

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

Id of an AccountRelationLabel 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.
`accountRelation`	CreateAccountRelationInput	Account relationship being labelled.
`accountRelationId`	ID	Id of the account relationship.
`accountRelationTypeId`	ID	Id of the relationship type.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAccountRelationLabelPayload object result: BulkUpdateResults!

Result of the bulkUpdateAccountRelationLabel mutation.

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

CreateAccountRelationLabelPayload object accountRelationLabel: AccountRelationLabelEntity, clientMutationId: String

Result of the createAccountRelationLabel mutation.

Field	Type	Description
`accountRelationLabel`	AccountRelationLabelEntity	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).

DeleteAccountRelationLabelPayload object accountRelationLabel: AccountRelationLabelEntity, clientMutationId: String

Result of the deleteAccountRelationLabel mutation.

Field	Type	Description
`accountRelationLabel`	AccountRelationLabelEntity	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).

UpdateAccountRelationLabelPayload object accountRelationLabel: AccountRelationLabelEntity, clientMutationId: String

Result of the updateAccountRelationLabel mutation.

Field	Type	Description
`accountRelationLabel`	AccountRelationLabelEntity	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).