GraphQL RepositoriesapprovalApprover

`entities.approvalApprover`

Read approval approver records with the approvalApprover repository, and change them with the approval approver mutations. Same records as the REST ApprovalApprovers entity.

Example: first three approval approver recordsGraphQLcURL

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

Queries

Fields of entities { approvalApprover { … } }.

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.	ApprovalApproverEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ApprovalApproverEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ApprovalApproverFilterInput, orderBy: [ApprovalApproverOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ApprovalApproverEntity!]!
QUERY	`getByCriteria`(filter: ApprovalApproverFilterInput, orderBy: [ApprovalApproverOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ApprovalApproverEntityConnection
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	`createApprovalApprover`(input: CreateApprovalApproverInput!, validationLevel: [ValidationLevel!])	Create one record	CreateApprovalApproverPayload
MUTATION	`updateApprovalApprover`(input: UpdateApprovalApproverInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateApprovalApproverPayload
MUTATION	`bulkUpdateApprovalApprover`(input: [CreateOrUpdateApprovalApproverInput!]!, deleteInput: [DeleteApprovalApproverInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateApprovalApproverPayload
MUTATION	`deleteApprovalApprover`(input: DeleteApprovalApproverInput!)	Soft-delete	DeleteApprovalApproverPayload

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.

ApprovalApproverEntity object 13 fields: isDeleteProtected, id, isDeleted, …

User asked to decide an approval request, with their response and comment.

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.
`approval`	ApprovalEntity	Approval this approver is assigned to.
`client`	ClientEntity	User responsible for approving (or rejecting) the request.
`approvalId`	ID!	Id of the approval this approver is assigned to.
`clientId`	ID!	Id of the assigned user.
`comment`	String	Comment the user attached when responding to the approval.
`status`	ApprovalStatusEnum	Response of this approver to the approval request: Pending until the user approves or rejects it.
`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.

ApprovalApproverEntityConnection object pageInfo: PageInfo!, edges: [ApprovalApproverEntityEdge]!, totalCount: Int

Paginated list of ApprovalApprover records.

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

ApprovalApproverEntityEdge object node: ApprovalApproverEntity, cursor: String!

A Relay edge containing a ApprovalApproverEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ApprovalApproverFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ApprovalApproverFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ApprovalApproverFilterInput	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.
`approvalId`	EntityFilterStringField	Id of the approval this approver is assigned to.
`clientId`	EntityFilterStringField	Id of the assigned user.
`comment`	EntityFilterStringField	Comment the user attached when responding to the approval.
`status`	ApprovalStatusEnumFilterInput	Response of this approver to the approval request: Pending until the user approves or rejects it.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`approval`	ApprovalFilterInput	Approval this approver is assigned to. Matches records where a related record meets these conditions.
`client`	ClientFilterInput	User responsible for approving (or rejecting) the request. Matches records where a related record meets these conditions.

ApprovalApproverOrderByInput input Asc or Desc per field

Sorting of ApprovalApprover 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.
`approval`	[ApprovalOrderByNestedInput!]	Approval this approver is assigned to. Sorts by fields of the related record, listed in order of priority.
`client`	[ClientOrderByNestedInput!]	User responsible for approving (or rejecting) the request. Sorts by fields of the related record, listed in order of priority.
`approvalId`	OrderByEnum	Id of the approval this approver is assigned to.
`clientId`	OrderByEnum	Id of the assigned user.
`comment`	OrderByEnum	Comment the user attached when responding to the approval.
`status`	OrderByEnum	Response of this approver to the approval request: Pending until the user approves or rejects it.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateApprovalApproverInput input 8 fields: clientMutationId, modified, created, …

Field values of a new ApprovalApprover 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.
`approvalId`	ID!	Id of the approval this approver is assigned to.
`clientId`	ID!	Id of the assigned user.
`comment`	String	Comment the user attached when responding to the approval.
`status`	ApprovalStatusEnum	Response of this approver to the approval request: Pending until the user approves or rejects it.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateApprovalApproverInput input 9 fields: clientMutationId, id, modified, …

Field values of an ApprovalApprover 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.
`approvalId`	ID	Id of the approval this approver is assigned to.
`clientId`	ID	Id of the assigned user.
`comment`	String	Comment the user attached when responding to the approval.
`status`	ApprovalStatusEnum	Response of this approver to the approval request: Pending until the user approves or rejects it.
`revision`	Int	Revision when entity was lastly changed.

DeleteApprovalApproverInput input clientMutationId: String, id: ID!

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

UpdateApprovalApproverInput input 9 fields: clientMutationId, id, modified, …

Id of an ApprovalApprover 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.
`approvalId`	ID	Id of the approval this approver is assigned to.
`clientId`	ID	Id of the assigned user.
`comment`	String	Comment the user attached when responding to the approval.
`status`	ApprovalStatusEnum	Response of this approver to the approval request: Pending until the user approves or rejects it.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateApprovalApproverPayload object result: BulkUpdateResults!

Result of the bulkUpdateApprovalApprover mutation.

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

CreateApprovalApproverPayload object approvalApprover: ApprovalApproverEntity, clientMutationId: String

Result of the createApprovalApprover mutation.

Field	Type	Description
`approvalApprover`	ApprovalApproverEntity	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).

DeleteApprovalApproverPayload object approvalApprover: ApprovalApproverEntity, clientMutationId: String

Result of the deleteApprovalApprover mutation.

Field	Type	Description
`approvalApprover`	ApprovalApproverEntity	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).

UpdateApprovalApproverPayload object approvalApprover: ApprovalApproverEntity, clientMutationId: String

Result of the updateApprovalApprover mutation.

Field	Type	Description
`approvalApprover`	ApprovalApproverEntity	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).