OBJECT
StepChecklistEntity

Checklist item of a pipeline step, such as logging an activity, filling a field or attaching a document.
GraphQL Schema definition

type StepChecklistEntity {
# 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.
isDeleteProtected: Boolean! 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# Appointment type that satisfies this checklist item. Set when activityTypeId 
# resolves to an AppointmentType.
appointmentType: AppointmentTypeEntity 
# Task type that satisfies this checklist item. Set when activityTypeId resolves 
# to a TaskType.
taskType: TaskTypeEntity 
# Document template the checklist item fills and attaches to the record. Set when 
# itemType is UseDocumentTemplate.
cloudObjectTemplate: CloudObjectTemplateEntity 
# Email sequence the item should enroll the record into.
emailSequence: EmailSequenceEntity 
# Field whose value satisfies this checklist item. Set when itemType is FieldType.
field: FieldEntity 
# Automatizer process that completes the item once it has run for the record. Set 
# when itemType is RunProcess.
process: ProcessEntity 
# Field that supplies the recipient email address when the checklist item triggers 
# sending an email.
sendEmailField: FieldEntity 
# Contact or Account lookup field whose primary record supplies the recipient. 
# When set, sendEmailField is read from that record instead of the Primary Contact 
# or Primary Account. Only lookup fields with a primary record are valid.
sendEmailLookupField: FieldEntity 
# Email template the email is pre-filled with when the item is completed by 
# sending an email. Set when itemType is SendEmail.
sendEmailTemplate: EmailTemplateEntity 
# Pipeline or process step this checklist item belongs to.
step: StepEntity 
# Id of the appointment or task type that satisfies the checklist item, or empty 
# when the item is not activity-based.
activityTypeId: ID 
# File format of the document generated from cloudObjectTemplate when itemType is 
# UseDocumentTemplate: the template's own format or PDF.
cloudObjectFormat: StepChecklistDocumentFormatEnum 
# Id of the document template the checklist item fills and attaches to the record. 
# Set when itemType is UseDocumentTemplate.
cloudObjectTemplateId: ID 
# Free-text description shown alongside the checklist item.
description: String 
# Id of the email sequence the record must be enrolled in to complete the item. 
# Set when itemType is EnrollToEmailSequence.
emailSequenceId: ID 
# Id of the related field.
fieldId: ID 
# Kind of checklist item, which determines what completes it, such as checking it 
# off, filling in field, logging an activity of activityTypeId or running process.
itemType: StepChecklistTypeEnum 
# Condition the item must meet before the record can move past the step; empty 
# when the item is optional. RelatedActivityCompleted is allowed only when 
# itemType is ActivityType.
itemValidation: StepChecklistValidationEnum 
# Display label of the checklist item.
label: String 
# When true, label is treated as a translation key and localized in the UI; 
# otherwise the literal text is shown.
labelUseLang: Boolean 
# Id of the related process.
processId: ID 
# Id of the recipient field.
sendEmailFieldId: ID 
# Id of the Contact or Account lookup field whose primary record supplies the 
# recipient; empty when the recipient comes from the Primary Contact or Primary 
# Account.
sendEmailLookupFieldId: ID 
# Id of the email template the email is pre-filled with when the item is completed 
# by sending an email. Set when itemType is SendEmail; empty when no template is 
# preset.
sendEmailTemplateId: ID 
# Position of the checklist item within its step; lower values appear first.
sortOrder: Int! 
# Id of the pipeline or process step this checklist item belongs to.
stepId: ID! 
# Filter expression that controls when the checklist item is shown. The item is 
# visible only when the record matches this filter; defaults to a no-op filter 
# matching all records. This payload conforms to the 
# `StepChecklistVisibilityFilter` JSON Schema: 
# https://api-doc.coevera.com/schemas/StepChecklistVisibilityFilter.json
visibilityCondition: StepChecklistVisibilityFilter! 
# Whether the item is always shown on the record or only when the record matches 
# visibilityCondition.
visibilityType: StepChecklistVisibilityEnum 
# Revision when entity was lastly changed.
revision: Int 
# Sales roles the checklist item is shown to. Empty means the item is shown to all 
# roles.
# 
# Arguments
# filter: Filter SalesRole relations by target SalesRole 
# attributes.
# filterEdge: Filter StepChecklistSalesRoleRelation relations by 
# edge (relation) StepChecklistSalesRoleRelation attributes.
# orderBy: Order SalesRole relations by target SalesRole 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
salesRoles(
filter: SalesRoleFilterInput,
filterEdge: StepChecklistSalesRoleRelationFilterInput,
orderBy: [SalesRoleOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): StepChecklistSalesRoleRelationEntityConnection 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
}
StepChecklistEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
