GraphQL RepositoriesleadOpptyStepCheckListRelation

`entities.leadOpptyStepCheckListRelation`

Read lead oppty step check list relation records with the leadOpptyStepCheckListRelation repository, and change them with the lead oppty step check list relation mutations. Same records as the REST LeadOpptyStepCheckListRelations entity.

Example: first three lead oppty step check list relation recordsGraphQLcURL

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

Queries

Fields of entities { leadOpptyStepCheckListRelation { … } }.

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.	LeadOpptyStepCheckListRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadOpptyStepCheckListRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadOpptyStepCheckListRelationFilterInput, orderBy: [LeadOpptyStepCheckListRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadOpptyStepCheckListRelationEntity!]!
QUERY	`getByCriteria`(filter: LeadOpptyStepCheckListRelationFilterInput, orderBy: [LeadOpptyStepCheckListRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadOpptyStepCheckListRelationEntityConnection
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	`createLeadOpptyStepCheckListRelation`(input: CreateLeadOpptyStepCheckListRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateLeadOpptyStepCheckListRelationPayload
MUTATION	`updateLeadOpptyStepCheckListRelation`(input: UpdateLeadOpptyStepCheckListRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateLeadOpptyStepCheckListRelationPayload
MUTATION	`bulkUpdateLeadOpptyStepCheckListRelation`(input: [CreateOrUpdateLeadOpptyStepCheckListRelationInput!]!, deleteInput: [DeleteLeadOpptyStepCheckListRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateLeadOpptyStepCheckListRelationPayload
MUTATION	`deleteLeadOpptyStepCheckListRelation`(input: DeleteLeadOpptyStepCheckListRelationInput!)	Soft-delete	DeleteLeadOpptyStepCheckListRelationPayload

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.

LeadOpptyStepCheckListRelationEntity object 24 fields: isDeleteProtected, id, isDeleted, …

Completion of a step checklist item on a lead, opportunity or quote, with the activity, email, note or document that fulfils it.

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.
`appointment`	AppointmentEntity	Appointment used as evidence for this checklist item. Set when activityId resolves to an Appointment; otherwise empty.
`task`	TaskEntity	Task used as evidence for this checklist item. Set when activityId resolves to a Task; otherwise empty.
`cloudObject`	CloudObjectEntity	Document linked as evidence for this checklist item.
`email`	EmailEntity	Email linked as evidence for this checklist item.
`lead`	LeadEntity	Lead this checklist completion belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty.
`oppty`	OpportunityEntity	Opportunity this checklist completion belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty.
`note`	NoteEntity	Note linked as evidence for this checklist item.
`quote`	QuoteEntity	Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklist`	StepChecklistEntity	Step checklist item this completion record refers to.
`activityId`	ID	Id of the appointment or task linked as evidence for this checklist item.
`cloudObjectId`	ID	Id of the document.
`emailId`	ID	Id of the email linked as evidence for this checklist item.
`itemChecked`	Boolean	True when the checklist item has been completed for this lead, opportunity or quote.
`leadOpptyId`	ID	Id of the lead or opportunity, or empty when this completion belongs to a quote.
`noteId`	ID	Id of the note linked as evidence for this checklist item.
`quoteId`	ID	Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklistId`	ID!	Id of the step checklist item.
`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.

LeadOpptyStepCheckListRelationEntityConnection object pageInfo: PageInfo!, edges: [LeadOpptyStepCheckListRelationEntityEdge]!, totalCount: Int

Paginated list of LeadOpptyStepCheckListRelation records.

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

LeadOpptyStepCheckListRelationEntityEdge object node: LeadOpptyStepCheckListRelationEntity, cursor: String!

A Relay edge containing a LeadOpptyStepCheckListRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[LeadOpptyStepCheckListRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[LeadOpptyStepCheckListRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	LeadOpptyStepCheckListRelationFilterInput	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.
`activityId`	EntityFilterStringField	Id of the appointment or task linked as evidence for this checklist item.
`cloudObjectId`	EntityFilterStringField	Id of the document.
`emailId`	EntityFilterStringField	Id of the email linked as evidence for this checklist item.
`itemChecked`	Boolean	True when the checklist item has been completed for this lead, opportunity or quote.
`leadOpptyId`	EntityFilterStringField	Id of the lead or opportunity, or empty when this completion belongs to a quote.
`noteId`	EntityFilterStringField	Id of the note linked as evidence for this checklist item.
`quoteId`	EntityFilterStringField	Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklistId`	EntityFilterStringField	Id of the step checklist item.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`appointment`	AppointmentFilterInput	Appointment used as evidence for this checklist item. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions.
`task`	TaskFilterInput	Task used as evidence for this checklist item. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions.
`cloudObject`	CloudObjectFilterInput	Document linked as evidence for this checklist item. Matches records where a related record meets these conditions.
`email`	EmailFilterInput	Email linked as evidence for this checklist item. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead this checklist completion belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity this checklist completion belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions.
`note`	NoteFilterInput	Note linked as evidence for this checklist item. Matches records where a related record meets these conditions.
`quote`	QuoteFilterInput	Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. Matches records where a related record meets these conditions.
`stepChecklist`	StepChecklistFilterInput	Step checklist item this completion record refers to. Matches records where a related record meets these conditions.

LeadOpptyStepCheckListRelationOrderByInput input Asc or Desc per field

Sorting of LeadOpptyStepCheckListRelation 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.
`appointment`	[AppointmentOrderByNestedInput!]	Appointment used as evidence for this checklist item. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`task`	[TaskOrderByNestedInput!]	Task used as evidence for this checklist item. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`cloudObject`	[CloudObjectOrderByNestedInput!]	Document linked as evidence for this checklist item. Sorts by fields of the related record, listed in order of priority.
`email`	[EmailOrderByNestedInput!]	Email linked as evidence for this checklist item. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead this checklist completion belongs to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity this checklist completion belongs to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`note`	[NoteOrderByNestedInput!]	Note linked as evidence for this checklist item. Sorts by fields of the related record, listed in order of priority.
`quote`	[QuoteOrderByNestedInput!]	Quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity. Sorts by fields of the related record, listed in order of priority.
`stepChecklist`	[StepChecklistOrderByNestedInput!]	Step checklist item this completion record refers to. Sorts by fields of the related record, listed in order of priority.
`activityId`	OrderByEnum	Id of the appointment or task linked as evidence for this checklist item.
`cloudObjectId`	OrderByEnum	Id of the document.
`emailId`	OrderByEnum	Id of the email linked as evidence for this checklist item.
`itemChecked`	OrderByEnum	True when the checklist item has been completed for this lead, opportunity or quote.
`leadOpptyId`	OrderByEnum	Id of the lead or opportunity, or empty when this completion belongs to a quote.
`noteId`	OrderByEnum	Id of the note linked as evidence for this checklist item.
`quoteId`	OrderByEnum	Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklistId`	OrderByEnum	Id of the step checklist item.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CloudObjectOrderByNestedInput input 13 fields: id, isDeleted, modified, …

Sorting by a field of the related CloudObject record. Set exactly one field in each item.

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.
`applicationId`	OrderByEnum	Id of the producing application.
`companyCloudObjectFolderId`	OrderByEnum	Id of the company folder, or empty when the object is not stored in the company tree.
`creatorId`	OrderByEnum	Id of the uploading user.
`filename`	OrderByEnum	File name (with extension) used when downloading the object.
`isPublic`	OrderByEnum	When true, the object can be served via a public URL (see publicUrl).
`mimeType`	OrderByEnum	Mime-type of the cloud object Is detected from content.
`size`	OrderByEnum	Size of the object in bytes.
`url`	OrderByEnum	URL of the object. If URL scheme is not defined "http://" is automatically prepended to supplied URL.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateLeadOpptyStepCheckListRelationInput input 14 fields: clientMutationId, modified, created, …

Field values of a new LeadOpptyStepCheckListRelation 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.
`cloudObject`	CreateCloudObjectInput	Document linked as evidence for this checklist item.
`note`	CreateNoteInput	Note linked as evidence for this checklist item.
`activityId`	ID	Id of the appointment or task linked as evidence for this checklist item.
`cloudObjectId`	ID	Id of the document.
`emailId`	ID	Id of the email linked as evidence for this checklist item.
`itemChecked`	Boolean	True when the checklist item has been completed for this lead, opportunity or quote.
`leadOpptyId`	ID	Id of the lead or opportunity, or empty when this completion belongs to a quote.
`noteId`	ID	Id of the note linked as evidence for this checklist item.
`quoteId`	ID	Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklistId`	ID!	Id of the step checklist item.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateLeadOpptyStepCheckListRelationInput input 15 fields: clientMutationId, id, modified, …

Field values of a LeadOpptyStepCheckListRelation 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.
`cloudObject`	CreateCloudObjectInput	Document linked as evidence for this checklist item.
`note`	CreateNoteInput	Note linked as evidence for this checklist item.
`activityId`	ID	Id of the appointment or task linked as evidence for this checklist item.
`cloudObjectId`	ID	Id of the document.
`emailId`	ID	Id of the email linked as evidence for this checklist item.
`itemChecked`	Boolean	True when the checklist item has been completed for this lead, opportunity or quote.
`leadOpptyId`	ID	Id of the lead or opportunity, or empty when this completion belongs to a quote.
`noteId`	ID	Id of the note linked as evidence for this checklist item.
`quoteId`	ID	Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklistId`	ID	Id of the step checklist item.
`revision`	Int	Revision when entity was lastly changed.

DeleteLeadOpptyStepCheckListRelationInput input clientMutationId: String, id: ID!, activityId: ID, leadOpptyId: ID

Id of the LeadOpptyStepCheckListRelation 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.
`activityId`	ID	Id of the appointment or task linked as evidence for this checklist item.
`leadOpptyId`	ID	Id of the lead or opportunity, or empty when this completion belongs to a quote.

NoteOrderByNestedInput input 13 fields: id, isDeleted, modified, …

Sorting by a field of the related Note record. Set exactly one field in each item.

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.
`accountId`	OrderByEnum	Id of the account the note is attached to.
`contactId`	OrderByEnum	Id of the contact the note is attached to.
`customEntityId`	OrderByEnum	Id of the custom entity record the note is attached to.
`leadOpptyId`	OrderByEnum	Id of the lead or opportunity the note is attached to.
`note`	OrderByEnum	Free-form text body of the note (sanitized HTML allowed).
`ownerId`	OrderByEnum	Id of the note author.
`projectId`	OrderByEnum	Id of the project the note is attached to.
`quoteId`	OrderByEnum	Id of the quote the note is attached to.
`revision`	OrderByEnum	Revision when entity was lastly changed.

UpdateLeadOpptyStepCheckListRelationInput input 15 fields: clientMutationId, id, modified, …

Id of a LeadOpptyStepCheckListRelation 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.
`cloudObject`	CreateCloudObjectInput	Document linked as evidence for this checklist item.
`note`	CreateNoteInput	Note linked as evidence for this checklist item.
`activityId`	ID	Id of the appointment or task linked as evidence for this checklist item.
`cloudObjectId`	ID	Id of the document.
`emailId`	ID	Id of the email linked as evidence for this checklist item.
`itemChecked`	Boolean	True when the checklist item has been completed for this lead, opportunity or quote.
`leadOpptyId`	ID	Id of the lead or opportunity, or empty when this completion belongs to a quote.
`noteId`	ID	Id of the note linked as evidence for this checklist item.
`quoteId`	ID	Id of the quote this checklist completion belongs to, or empty when it belongs to a lead or opportunity.
`stepChecklistId`	ID	Id of the step checklist item.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateLeadOpptyStepCheckListRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateLeadOpptyStepCheckListRelation mutation.

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

CreateLeadOpptyStepCheckListRelationPayload object leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationEntity, clientMutationId: String

Result of the createLeadOpptyStepCheckListRelation mutation.

Field	Type	Description
`leadOpptyStepCheckListRelation`	LeadOpptyStepCheckListRelationEntity	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).

DeleteLeadOpptyStepCheckListRelationPayload object leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationEntity, clientMutationId: String

Result of the deleteLeadOpptyStepCheckListRelation mutation.

Field	Type	Description
`leadOpptyStepCheckListRelation`	LeadOpptyStepCheckListRelationEntity	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).

UpdateLeadOpptyStepCheckListRelationPayload object leadOpptyStepCheckListRelation: LeadOpptyStepCheckListRelationEntity, clientMutationId: String

Result of the updateLeadOpptyStepCheckListRelation mutation.

Field	Type	Description
`leadOpptyStepCheckListRelation`	LeadOpptyStepCheckListRelationEntity	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).