GraphQL RepositoriesaccountRelation

`entities.accountRelation`

Read account relation records with the accountRelation repository, and change them with the account relation mutations. Same records as the REST AccountRelations entity.

Example: first three account relation recordsGraphQLcURL

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

Queries

Fields of entities { accountRelation { … } }.

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.	AccountRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AccountRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AccountRelationFilterInput, orderBy: [AccountRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AccountRelationEntity!]!
QUERY	`getByCriteria`(filter: AccountRelationFilterInput, orderBy: [AccountRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[AccountRelationEntity!]!
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	`createAccountRelation`(input: CreateAccountRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAccountRelationPayload
MUTATION	`updateAccountRelation`(input: UpdateAccountRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAccountRelationPayload
MUTATION	`bulkUpdateAccountRelation`(input: [CreateOrUpdateAccountRelationInput!]!, deleteInput: [DeleteAccountRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAccountRelationPayload
MUTATION	`deleteAccountRelation`(input: DeleteAccountRelationInput!)	Soft-delete	DeleteAccountRelationPayload

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.

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

Link between two related accounts, such as partners or a supplier and its customer; 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.
`account1`	AccountEntity	One side of the account-to-account relationship.
`account2`	AccountEntity	Other side of the account-to-account relationship.
`account1Id`	ID!	Id of the first related account.
`account2Id`	ID!	Id of the second related account.
`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.

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

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

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

AccountRelationOrderByInput input Asc or Desc per field

Sorting of AccountRelation 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.
`account1`	[AccountOrderByNestedInput!]	One side of the account-to-account relationship. Sorts by fields of the related record, listed in order of priority.
`account2`	[AccountOrderByNestedInput!]	Other side of the account-to-account relationship. Sorts by fields of the related record, listed in order of priority.
`account1Id`	OrderByEnum	Id of the first related account.
`account2Id`	OrderByEnum	Id of the second related account.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new AccountRelation 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.
`account1Id`	ID!	Id of the first related account.
`account2Id`	ID!	Id of the second related account.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an AccountRelation 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.
`account1Id`	ID	Id of the first related account.
`account2Id`	ID	Id of the second related account.
`revision`	Int	Revision when entity was lastly changed.

DeleteAccountRelationInput input clientMutationId: String, id: ID!

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

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

Id of an AccountRelation 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.
`account1Id`	ID	Id of the first related account.
`account2Id`	ID	Id of the second related account.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAccountRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateAccountRelation mutation.

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

CreateAccountRelationPayload object accountRelation: AccountRelationEntity, clientMutationId: String

Result of the createAccountRelation mutation.

Field	Type	Description
`accountRelation`	AccountRelationEntity	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).

DeleteAccountRelationPayload object accountRelation: AccountRelationEntity, clientMutationId: String

Result of the deleteAccountRelation mutation.

Field	Type	Description
`accountRelation`	AccountRelationEntity	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).

UpdateAccountRelationPayload object accountRelation: AccountRelationEntity, clientMutationId: String

Result of the updateAccountRelation mutation.

Field	Type	Description
`accountRelation`	AccountRelationEntity	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).