GraphQL RepositoriesaccountRole

`entities.accountRole`

Read account role records with the accountRole repository, and change them with the account role mutations. Same records as the REST AccountRoles entity.

Example: first three account role recordsGraphQLcURL

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

Queries

Fields of entities { accountRole { … } }.

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.	AccountRoleEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AccountRoleEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AccountRoleFilterInput, orderBy: [AccountRoleOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AccountRoleEntity!]!
QUERY	`getByCriteria`(filter: AccountRoleFilterInput, orderBy: [AccountRoleOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AccountRoleEntityConnection
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	`createAccountRole`(input: CreateAccountRoleInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAccountRolePayload
MUTATION	`updateAccountRole`(input: UpdateAccountRoleInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAccountRolePayload
MUTATION	`bulkUpdateAccountRole`(input: [CreateOrUpdateAccountRoleInput!]!, deleteInput: [DeleteAccountRoleInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAccountRolePayload
MUTATION	`deleteAccountRole`(input: DeleteAccountRoleInput!)	Soft-delete	DeleteAccountRolePayload

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.

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

Role a contact can hold at an account, configurable per space and assigned on the link between the contact and the account.

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 role label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String!	Name of the entity and its default text representation.
`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.

AccountRoleEntityConnection object pageInfo: PageInfo!, edges: [AccountRoleEntityEdge]!, totalCount: Int

Paginated list of AccountRole records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[AccountRoleEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

AccountRoleEntityEdge object node: AccountRoleEntity, cursor: String!

A Relay edge containing a AccountRoleEntity and its cursor.

Field	Type	Description
`node`	AccountRoleEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

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

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

Input field	Type	Description
`OR`	[AccountRoleFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AccountRoleFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AccountRoleFilterInput	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 role label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	EntityFilterStringField	Name of the entity and its default text representation.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

AccountRoleOrderByInput input Asc or Desc per field

Sorting of AccountRole 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 role label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new AccountRole 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 role label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an AccountRole 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 role label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

DeleteAccountRoleInput input clientMutationId: String, id: ID!

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

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

Id of an AccountRole 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 role label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`label`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAccountRolePayload object result: BulkUpdateResults!

Result of the bulkUpdateAccountRole mutation.

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

CreateAccountRolePayload object accountRole: AccountRoleEntity, clientMutationId: String

Result of the createAccountRole mutation.

Field	Type	Description
`accountRole`	AccountRoleEntity	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).

DeleteAccountRolePayload object accountRole: AccountRoleEntity, clientMutationId: String

Result of the deleteAccountRole mutation.

Field	Type	Description
`accountRole`	AccountRoleEntity	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).

UpdateAccountRolePayload object accountRole: AccountRoleEntity, clientMutationId: String

Result of the updateAccountRole mutation.

Field	Type	Description
`accountRole`	AccountRoleEntity	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).