GraphQL RepositoriesallowedPipeline

`entities.allowedPipeline`

Read allowed pipeline records with the allowedPipeline repository, and change them with the allowed pipeline mutations. Same records as the REST AllowedPipelines entity.

Example: first three allowed pipeline recordsGraphQLcURL

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

Queries

Fields of entities { allowedPipeline { … } }.

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.	AllowedPipelineEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AllowedPipelineEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AllowedPipelineFilterInput, orderBy: [AllowedPipelineOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AllowedPipelineEntity!]!
QUERY	`getByCriteria`(filter: AllowedPipelineFilterInput, orderBy: [AllowedPipelineOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AllowedPipelineEntityConnection
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	`createAllowedPipeline`(input: CreateAllowedPipelineInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAllowedPipelinePayload
MUTATION	`updateAllowedPipeline`(input: UpdateAllowedPipelineInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAllowedPipelinePayload
MUTATION	`bulkUpdateAllowedPipeline`(input: [CreateOrUpdateAllowedPipelineInput!]!, deleteInput: [DeleteAllowedPipelineInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAllowedPipelinePayload
MUTATION	`deleteAllowedPipeline`(input: DeleteAllowedPipelineInput!)	Soft-delete	DeleteAllowedPipelinePayload

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.

AllowedPipelineEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Pipeline that a user role is allowed to use, optionally with access to the documents of its steps.

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.
`masterRight`	MasterRightEntity	User role granted access to the pipeline.
`pipeline`	PipelineEntity	Pipeline the user role can use.
`accessStepDocuments`	Boolean	When true, the user role can access documents attached to steps of this pipeline.
`masterRightId`	ID!	Id of the user role.
`pipelineId`	ID!	Id of the pipeline the user role can use.
`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.

AllowedPipelineEntityConnection object pageInfo: PageInfo!, edges: [AllowedPipelineEntityEdge]!, totalCount: Int

Paginated list of AllowedPipeline records.

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

AllowedPipelineEntityEdge object node: AllowedPipelineEntity, cursor: String!

A Relay edge containing a AllowedPipelineEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[AllowedPipelineFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AllowedPipelineFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AllowedPipelineFilterInput	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.
`accessStepDocuments`	Boolean	When true, the user role can access documents attached to steps of this pipeline.
`masterRightId`	EntityFilterStringField	Id of the user role.
`pipelineId`	EntityFilterStringField	Id of the pipeline the user role can use.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`masterRight`	MasterRightFilterInput	User role granted access to the pipeline. Matches records where a related record meets these conditions.
`pipeline`	PipelineFilterInput	Pipeline the user role can use. Matches records where a related record meets these conditions.

AllowedPipelineOrderByInput input Asc or Desc per field

Sorting of AllowedPipeline 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.
`masterRight`	[MasterRightOrderByNestedInput!]	User role granted access to the pipeline. Sorts by fields of the related record, listed in order of priority.
`pipeline`	[PipelineOrderByNestedInput!]	Pipeline the user role can use. Sorts by fields of the related record, listed in order of priority.
`accessStepDocuments`	OrderByEnum	When true, the user role can access documents attached to steps of this pipeline.
`masterRightId`	OrderByEnum	Id of the user role.
`pipelineId`	OrderByEnum	Id of the pipeline the user role can use.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new AllowedPipeline 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.
`accessStepDocuments`	Boolean	When true, the user role can access documents attached to steps of this pipeline.
`masterRightId`	ID!	Id of the user role.
`pipelineId`	ID!	Id of the pipeline the user role can use.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an AllowedPipeline 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.
`accessStepDocuments`	Boolean	When true, the user role can access documents attached to steps of this pipeline.
`masterRightId`	ID	Id of the user role.
`pipelineId`	ID	Id of the pipeline the user role can use.
`revision`	Int	Revision when entity was lastly changed.

DeleteAllowedPipelineInput input clientMutationId: String, id: ID!

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

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

Id of an AllowedPipeline 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.
`accessStepDocuments`	Boolean	When true, the user role can access documents attached to steps of this pipeline.
`masterRightId`	ID	Id of the user role.
`pipelineId`	ID	Id of the pipeline the user role can use.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAllowedPipelinePayload object result: BulkUpdateResults!

Result of the bulkUpdateAllowedPipeline mutation.

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

CreateAllowedPipelinePayload object allowedPipeline: AllowedPipelineEntity, clientMutationId: String

Result of the createAllowedPipeline mutation.

Field	Type	Description
`allowedPipeline`	AllowedPipelineEntity	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).

DeleteAllowedPipelinePayload object allowedPipeline: AllowedPipelineEntity, clientMutationId: String

Result of the deleteAllowedPipeline mutation.

Field	Type	Description
`allowedPipeline`	AllowedPipelineEntity	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).

UpdateAllowedPipelinePayload object allowedPipeline: AllowedPipelineEntity, clientMutationId: String

Result of the updateAllowedPipeline mutation.

Field	Type	Description
`allowedPipeline`	AllowedPipelineEntity	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).