GraphQL RepositoriesleadProcess

`entities.leadProcess`

Read lead process records with the leadProcess repository, and change them with the lead process mutations. Same records as the REST LeadProcesses entity.

Example: first three lead process recordsGraphQLcURL

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

Queries

Fields of entities { leadProcess { … } }.

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.	LeadProcessEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadProcessEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadProcessFilterInput, orderBy: [LeadProcessOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadProcessEntity!]!
QUERY	`getByCriteria`(filter: LeadProcessFilterInput, orderBy: [LeadProcessOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadProcessEntityConnection
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	`changeLeadProcess`(input: ChangeLeadProcessInput!)	Moves the lead to another lead process by changing its lead type and step, optionally changing its owner at the same time. Both leadTypeId and stepId must be sent. GraphQL only	ChangeLeadProcessPayload
MUTATION	`createLeadProcess`(input: CreateLeadProcessInput!, validationLevel: [ValidationLevel!])	Create one record	CreateLeadProcessPayload
MUTATION	`updateLeadProcess`(input: UpdateLeadProcessInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateLeadProcessPayload
MUTATION	`bulkUpdateLeadProcess`(input: [CreateOrUpdateLeadProcessInput!]!, deleteInput: [DeleteLeadProcessInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateLeadProcessPayload
MUTATION	`deleteLeadProcess`(input: DeleteLeadProcessInput!)	Soft-delete	DeleteLeadProcessPayload

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.

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

Lead process: the ordered steps that leads of its lead 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 lead process label, encoded as an integer packing the RGB components: (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 lead process, in evaluation order.
`leadTypes`	[LeadTypeEntity!]!	Lead types that follow this lead process.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

LeadProcessEntityConnection object pageInfo: PageInfo!, edges: [LeadProcessEntityEdge]!, totalCount: Int

Paginated list of LeadProcess records.

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

LeadProcessEntityEdge object node: LeadProcessEntity, cursor: String!

A Relay edge containing a LeadProcessEntity and its cursor.

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

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

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

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

LeadProcessOrderByInput input Asc or Desc per field

Sorting of LeadProcess 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 lead process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

ChangeLeadProcessInput input entity: UpdateLeadInput!, keepOwnerAsEditor: Boolean!, transferLinkedRecords: Boolean!, clientMutationId: String

Parameters of the changeLeadProcess mutation.

Input field	Type	Description
`entity`	UpdateLeadInput!	Id of the lead, the new leadTypeId and stepId, an optional new ownerId or unitId, and any other field values to save.
`keepOwnerAsEditor`	Boolean!	Adds the previous owner as an editor of the lead; a private lead becomes shared.
`transferLinkedRecords`	Boolean!	Gives the new owner the lead's open activities and its notes.
`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).

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

Field values of a new LeadProcess 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 lead process label, encoded as an integer packing the RGB components: (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`	[CreateStepNoLeadProcessBackrefInput!]!	Steps that make up this lead process, in evaluation order.

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

Field values of a LeadProcess 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 lead process label, encoded as an integer packing the RGB components: (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`	[CreateOrUpdateStepNoLeadProcessBackrefInput!]	Steps that make up this lead process, in evaluation order.

CreateOrUpdateStepNoLeadProcessBackrefInput 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.
`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.
`pipelineId`	ID	Id of the opportunity pipeline.
`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.

CreateStepNoLeadProcessBackrefInput 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.
`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.
`pipelineId`	ID	Id of the opportunity pipeline.
`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.

DeleteLeadProcessInput input clientMutationId: String, id: ID!

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

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

Id of a LeadProcess 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 lead process label, encoded as an integer packing the RGB components: (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`	[CreateOrUpdateStepNoLeadProcessBackrefInput!]	Steps that make up this lead process, in evaluation order.

BulkUpdateLeadProcessPayload object result: BulkUpdateResults!

Result of the bulkUpdateLeadProcess mutation.

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

ChangeLeadProcessPayload object result: LeadEntity, clientMutationId: String

Result of the changeLeadProcess mutation.

Field	Type	Description
`result`	LeadEntity	The updated lead.
`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).

CreateLeadProcessPayload object leadProcess: LeadProcessEntity, clientMutationId: String

Result of the createLeadProcess mutation.

Field	Type	Description
`leadProcess`	LeadProcessEntity	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).

DeleteLeadProcessPayload object leadProcess: LeadProcessEntity, clientMutationId: String

Result of the deleteLeadProcess mutation.

Field	Type	Description
`leadProcess`	LeadProcessEntity	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).

UpdateLeadProcessPayload object leadProcess: LeadProcessEntity, clientMutationId: String

Result of the updateLeadProcess mutation.

Field	Type	Description
`leadProcess`	LeadProcessEntity	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).