--- title: entities.allowedPipeline description: Read allowed pipeline records with the allowedPipeline repository, and change them with the allowed pipeline mutations. Same records as the REST AllowedPipelines entity. canonical: https://developers.coevera.com/reference/graphql/allowed-pipeline/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # 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. REST: [AllowedPipelines](https://developers.coevera.com/reference/rest/allowed-pipelines.md). ## Queries - `getById(entityId: ID!): AllowedPipelineEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [AllowedPipelineEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. - `getAll(limit: Int, offset: Int, filter: AllowedPipelineFilterInput, orderBy: [AllowedPipelineOrderByInput!], includeDeleted: Boolean): [AllowedPipelineEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: AllowedPipelineFilterInput, orderBy: [AllowedPipelineOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): AllowedPipelineEntityConnection` Returns the records that match the filter as a cursor-paginated connection. - `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. ## Mutations - `createAllowedPipeline(input: CreateAllowedPipelineInput!, validationLevel: [ValidationLevel!]): CreateAllowedPipelinePayload` Create one record. - `updateAllowedPipeline(input: UpdateAllowedPipelineInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateAllowedPipelinePayload` Update fields. - `bulkUpdateAllowedPipeline(input: [CreateOrUpdateAllowedPipelineInput!]!, deleteInput: [DeleteAllowedPipelineInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateAllowedPipelinePayload` Create or update many; per-item results. - `deleteAllowedPipeline(input: DeleteAllowedPipelineInput!): DeleteAllowedPipelinePayload` Soft-delete. ## Types ### AllowedPipelineEntity (object) Pipeline that a user role is allowed to use, optionally with access to the documents of its steps. - `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) Paginated list of AllowedPipeline records. - `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) A Relay edge containing a `AllowedPipelineEntity` and its cursor. - `node: AllowedPipelineEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### AllowedPipelineFilterInput (input) Filter conditions for AllowedPipeline records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `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) Sorting of AllowedPipeline records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. - `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) Field values of a new AllowedPipeline 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). - `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) Field values of an AllowedPipeline record to create, or to update when its id is set. - `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) Id of the AllowedPipeline record to delete. - `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) Id of an AllowedPipeline record and the field values to change. - `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 of the bulkUpdateAllowedPipeline mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateAllowedPipelinePayload (object) Result of the createAllowedPipeline mutation. - `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) Result of the deleteAllowedPipeline mutation. - `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) Result of the updateAllowedPipeline mutation. - `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). Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file. ## Example ```graphql query FirstAllowedPipelines { entities { allowedPipeline { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } } ``` ```bash 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 } } } } } }"}' ```