GraphQL RepositoriesproductPipelineRelation

`entities.productPipelineRelation`

Read product pipeline relation records with the productPipelineRelation repository, and change them with the product pipeline relation mutations. Same records as the REST ProductPipelineRelations entity.

Example: first three product pipeline relation recordsGraphQLcURL

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

Queries

Fields of entities { productPipelineRelation { … } }.

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.	ProductPipelineRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ProductPipelineRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ProductPipelineRelationFilterInput, orderBy: [ProductPipelineRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ProductPipelineRelationEntity!]!
QUERY	`getByCriteria`(filter: ProductPipelineRelationFilterInput, orderBy: [ProductPipelineRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ProductPipelineRelationEntityConnection
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	`createProductPipelineRelation`(input: CreateProductPipelineRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateProductPipelineRelationPayload
MUTATION	`updateProductPipelineRelation`(input: UpdateProductPipelineRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateProductPipelineRelationPayload
MUTATION	`bulkUpdateProductPipelineRelation`(input: [CreateOrUpdateProductPipelineRelationInput!]!, deleteInput: [DeleteProductPipelineRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateProductPipelineRelationPayload
MUTATION	`deleteProductPipelineRelation`(input: DeleteProductPipelineRelationInput!)	Soft-delete	DeleteProductPipelineRelationPayload

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.

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

Pipeline in which a product can be added as a line item.

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.
`pipeline`	PipelineEntity	Pipeline in which the product can be added as a line item.
`product`	ProductEntity	Product available in the linked pipeline.
`pipelineId`	ID!	Id of the pipeline in which the product can be added as a line item.
`productId`	ID!	Id of the product made available in the pipeline.
`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.

ProductPipelineRelationEntityConnection object pageInfo: PageInfo!, edges: [ProductPipelineRelationEntityEdge]!, totalCount: Int

Paginated list of ProductPipelineRelation records.

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

ProductPipelineRelationEntityEdge object node: ProductPipelineRelationEntity, cursor: String!

A Relay edge containing a ProductPipelineRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[ProductPipelineRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ProductPipelineRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ProductPipelineRelationFilterInput	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.
`pipelineId`	EntityFilterStringField	Id of the pipeline in which the product can be added as a line item.
`productId`	EntityFilterStringField	Id of the product made available in the pipeline.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`pipeline`	PipelineFilterInput	Pipeline in which the product can be added as a line item. Matches records where a related record meets these conditions.
`product`	ProductFilterInput	Product available in the linked pipeline. Matches records where a related record meets these conditions.

ProductPipelineRelationOrderByInput input Asc or Desc per field

Sorting of ProductPipelineRelation 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.
`pipeline`	[PipelineOrderByNestedInput!]	Pipeline in which the product can be added as a line item. Sorts by fields of the related record, listed in order of priority.
`product`	[ProductOrderByNestedInput!]	Product available in the linked pipeline. Sorts by fields of the related record, listed in order of priority.
`pipelineId`	OrderByEnum	Id of the pipeline in which the product can be added as a line item.
`productId`	OrderByEnum	Id of the product made available in the pipeline.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a ProductPipelineRelation 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.
`pipelineId`	ID	Id of the pipeline in which the product can be added as a line item.
`productId`	ID	Id of the product made available in the pipeline.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a new ProductPipelineRelation 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.
`pipelineId`	ID!	Id of the pipeline in which the product can be added as a line item.
`productId`	ID!	Id of the product made available in the pipeline.
`revision`	Int	Revision when entity was lastly changed.

DeleteProductPipelineRelationInput input clientMutationId: String, id: ID!

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

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

Id of a ProductPipelineRelation 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.
`pipelineId`	ID	Id of the pipeline in which the product can be added as a line item.
`productId`	ID	Id of the product made available in the pipeline.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateProductPipelineRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateProductPipelineRelation mutation.

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

CreateProductPipelineRelationPayload object productPipelineRelation: ProductPipelineRelationEntity, clientMutationId: String

Result of the createProductPipelineRelation mutation.

Field	Type	Description
`productPipelineRelation`	ProductPipelineRelationEntity	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).

DeleteProductPipelineRelationPayload object productPipelineRelation: ProductPipelineRelationEntity, clientMutationId: String

Result of the deleteProductPipelineRelation mutation.

Field	Type	Description
`productPipelineRelation`	ProductPipelineRelationEntity	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).

UpdateProductPipelineRelationPayload object productPipelineRelation: ProductPipelineRelationEntity, clientMutationId: String

Result of the updateProductPipelineRelation mutation.

Field	Type	Description
`productPipelineRelation`	ProductPipelineRelationEntity	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).