GraphQL RepositoriesaccountRelationType

`entities.accountRelationType`

Read account relation type records with the accountRelationType repository, and change them with the account relation type mutations. Same records as the REST AccountRelationTypes entity.

Example: first three account relation type recordsGraphQLcURL

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

Queries

Fields of entities { accountRelationType { … } }.

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.	AccountRelationTypeEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AccountRelationTypeEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AccountRelationTypeFilterInput, orderBy: [AccountRelationTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AccountRelationTypeEntity!]!
QUERY	`getByCriteria`(filter: AccountRelationTypeFilterInput, orderBy: [AccountRelationTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[AccountRelationTypeEntity!]!
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	`createAccountRelationType`(input: CreateAccountRelationTypeInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAccountRelationTypePayload
MUTATION	`updateAccountRelationType`(input: UpdateAccountRelationTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAccountRelationTypePayload
MUTATION	`bulkUpdateAccountRelationType`(input: [CreateOrUpdateAccountRelationTypeInput!]!, deleteInput: [DeleteAccountRelationTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAccountRelationTypePayload
MUTATION	`deleteAccountRelationType`(input: DeleteAccountRelationTypeInput!)	Soft-delete	DeleteAccountRelationTypePayload

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.

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

Kind of relationship that can be assigned to a link between two accounts, such as Partner or Supplier, 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 account-to-account relationship type (e.g. Partner, Supplier).
`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.

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

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

Input field	Type	Description
`OR`	[AccountRelationTypeFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AccountRelationTypeFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AccountRelationTypeFilterInput	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 account-to-account relationship type (e.g. Partner, Supplier).
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

AccountRelationTypeOrderByInput input Asc or Desc per field

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

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

Field values of a new AccountRelationType 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 account-to-account relationship type (e.g. Partner, Supplier).
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an AccountRelationType 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 account-to-account relationship type (e.g. Partner, Supplier).
`revision`	Int	Revision when entity was lastly changed.

DeleteAccountRelationTypeInput input clientMutationId: String, id: ID!

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

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

Id of an AccountRelationType 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 account-to-account relationship type (e.g. Partner, Supplier).
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAccountRelationTypePayload object result: BulkUpdateResults!

Result of the bulkUpdateAccountRelationType mutation.

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

CreateAccountRelationTypePayload object accountRelationType: AccountRelationTypeEntity, clientMutationId: String

Result of the createAccountRelationType mutation.

Field	Type	Description
`accountRelationType`	AccountRelationTypeEntity	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).

DeleteAccountRelationTypePayload object accountRelationType: AccountRelationTypeEntity, clientMutationId: String

Result of the deleteAccountRelationType mutation.

Field	Type	Description
`accountRelationType`	AccountRelationTypeEntity	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).

UpdateAccountRelationTypePayload object accountRelationType: AccountRelationTypeEntity, clientMutationId: String

Result of the updateAccountRelationType mutation.

Field	Type	Description
`accountRelationType`	AccountRelationTypeEntity	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).