GraphQL Repositoriespipeline

`entities.pipeline`

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

Example: first three pipeline recordsGraphQLcURL

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

Queries

Fields of entities { pipeline { … } }.

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.	PipelineEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[PipelineEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: PipelineFilterInput, orderBy: [PipelineOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[PipelineEntity!]!
QUERY	`getByCriteria`(filter: PipelineFilterInput, orderBy: [PipelineOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	PipelineEntityConnection
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!]!
QUERY	`getDefaultPipeline` Returns the default pipeline of the space.	PipelineEntity!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createPipeline`(input: CreatePipelineInput!, validationLevel: [ValidationLevel!])	Create one record	CreatePipelinePayload
MUTATION	`updatePipeline`(input: UpdatePipelineInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdatePipelinePayload
MUTATION	`bulkUpdatePipeline`(input: [CreateOrUpdatePipelineInput!]!, deleteInput: [DeletePipelineInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdatePipelinePayload
MUTATION	`deletePipeline`(input: DeletePipelineInput!)	Soft-delete	DeletePipelinePayload

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.

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

Sales pipeline: the ordered steps that opportunities of its opportunity types move through.

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 pipeline label, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[StepEntity!]!	Steps that make up this pipeline, in the order opportunities move through them.
`opportunityTypes`	[OpportunityTypeEntity!]!	Opportunity types that follow this pipeline.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

PipelineEntityConnection object pageInfo: PageInfo!, edges: [PipelineEntityEdge]!, totalCount: Int

Paginated list of Pipeline records.

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

PipelineEntityEdge object node: PipelineEntity, cursor: String!

A Relay edge containing a PipelineEntity and its cursor.

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

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

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

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

PipelineOrderByInput input Asc or Desc per field

Sorting of Pipeline 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 pipeline label, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a Pipeline 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 pipeline label, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[CreateOrUpdateStepNoPipelineBackrefInput!]	Steps that make up this pipeline, in the order opportunities move through them.

CreateOrUpdateStepNoPipelineBackrefInput input 15 fields: id, modified, created, …

Field values of a Step record to create, or to update when its id is set, together with the record it belongs to.

Input field	Type	Description
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description shown in the step UI.
`hasReadonlyForm`	Boolean	When true, the record form is read-only while a record is in this step.
`hasVersionIncrement`	Boolean	When true, transitioning a record into this step bumps its version counter.
`leadProcessId`	ID	Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
`name`	String	Name of the entity and its default text representation.
`percent`	Int	Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
`quoteProcessId`	ID	Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
`sortOrder`	Int	Position of the step within its pipeline or process; lower values appear first.
`timeframe`	Int	Expected number of days a record should spend in this step. Used to flag overdue records.
`revision`	Int	Revision when entity was lastly changed.
`documents`	[CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!]	Files attached to the step (e.g. step-specific documentation or templates).
`stepChecklists`	[CreateOrUpdateStepChecklistNoStepBackrefInput!]	Checklist items the user must complete before moving a record out of this step.

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

Field values of a new Pipeline 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 pipeline label, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[CreateStepNoPipelineBackrefInput!]!	Steps that make up this pipeline, in the order opportunities move through them.

CreateStepNoPipelineBackrefInput input 14 fields: modified, created, description, …

Field values of a new Step record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description shown in the step UI.
`hasReadonlyForm`	Boolean	When true, the record form is read-only while a record is in this step.
`hasVersionIncrement`	Boolean	When true, transitioning a record into this step bumps its version counter.
`leadProcessId`	ID	Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
`name`	String!	Name of the entity and its default text representation.
`percent`	Int	Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
`quoteProcessId`	ID	Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
`sortOrder`	Int	Position of the step within its pipeline or process; lower values appear first.
`timeframe`	Int	Expected number of days a record should spend in this step. Used to flag overdue records.
`revision`	Int	Revision when entity was lastly changed.
`documents`	[CreateCloudObjectStepRelationNoStepBackrefInput!]	Files attached to the step (e.g. step-specific documentation or templates).
`stepChecklists`	[CreateStepChecklistNoStepBackrefInput!]	Checklist items the user must complete before moving a record out of this step.

DeletePipelineInput input clientMutationId: String, id: ID!

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

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

Id of a Pipeline 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 pipeline label, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[CreateOrUpdateStepNoPipelineBackrefInput!]	Steps that make up this pipeline, in the order opportunities move through them.

BulkUpdatePipelinePayload object result: BulkUpdateResults!

Result of the bulkUpdatePipeline mutation.

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

CreatePipelinePayload object pipeline: PipelineEntity, clientMutationId: String

Result of the createPipeline mutation.

Field	Type	Description
`pipeline`	PipelineEntity	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).

DeletePipelinePayload object pipeline: PipelineEntity, clientMutationId: String

Result of the deletePipeline mutation.

Field	Type	Description
`pipeline`	PipelineEntity	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).

UpdatePipelinePayload object pipeline: PipelineEntity, clientMutationId: String

Result of the updatePipeline mutation.

Field	Type	Description
`pipeline`	PipelineEntity	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).