GraphQL RepositoriesstepChecklistSalesRoleRelation

`entities.stepChecklistSalesRoleRelation`

Read step checklist sales role relation records with the stepChecklistSalesRoleRelation repository, and change them with the step checklist sales role relation mutations. Same records as the REST StepChecklistSalesRoleRelations entity.

Example: first three step checklist sales role relation recordsGraphQLcURL

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

Queries

Fields of entities { stepChecklistSalesRoleRelation { … } }.

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.	StepChecklistSalesRoleRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[StepChecklistSalesRoleRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: StepChecklistSalesRoleRelationFilterInput, orderBy: [StepChecklistSalesRoleRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[StepChecklistSalesRoleRelationEntity!]!
QUERY	`getByCriteria`(filter: StepChecklistSalesRoleRelationFilterInput, orderBy: [StepChecklistSalesRoleRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	StepChecklistSalesRoleRelationEntityConnection
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	`createStepChecklistSalesRoleRelation`(input: CreateStepChecklistSalesRoleRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateStepChecklistSalesRoleRelationPayload
MUTATION	`updateStepChecklistSalesRoleRelation`(input: UpdateStepChecklistSalesRoleRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateStepChecklistSalesRoleRelationPayload
MUTATION	`bulkUpdateStepChecklistSalesRoleRelation`(input: [CreateOrUpdateStepChecklistSalesRoleRelationInput!]!, deleteInput: [DeleteStepChecklistSalesRoleRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateStepChecklistSalesRoleRelationPayload
MUTATION	`deleteStepChecklistSalesRoleRelation`(input: DeleteStepChecklistSalesRoleRelationInput!)	Soft-delete	DeleteStepChecklistSalesRoleRelationPayload

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.

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

Sales role that a step checklist item is shown to.

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.
`salesRole`	SalesRoleEntity	Sales role that sees the checklist item.
`stepChecklist`	StepChecklistEntity	Checklist item the role is granted access to.
`salesRoleId`	ID!	Id of the sales role that sees the checklist item.
`stepChecklistId`	ID!	Id of the 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.

StepChecklistSalesRoleRelationEntityConnection object pageInfo: PageInfo!, edges: [StepChecklistSalesRoleRelationEntityEdge]!, totalCount: Int

Paginated list of StepChecklistSalesRoleRelation records.

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

StepChecklistSalesRoleRelationEntityEdge object node: StepChecklistSalesRoleRelationEntity, cursor: String!

A Relay edge containing a StepChecklistSalesRoleRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[StepChecklistSalesRoleRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[StepChecklistSalesRoleRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	StepChecklistSalesRoleRelationFilterInput	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.
`salesRoleId`	EntityFilterStringField	Id of the sales role that sees the checklist item.
`stepChecklistId`	EntityFilterStringField	Id of the checklist item.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`salesRole`	SalesRoleFilterInput	Sales role that sees the checklist item. Matches records where a related record meets these conditions.
`stepChecklist`	StepChecklistFilterInput	Checklist item the role is granted access to. Matches records where a related record meets these conditions.

StepChecklistSalesRoleRelationOrderByInput input Asc or Desc per field

Sorting of StepChecklistSalesRoleRelation 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.
`salesRole`	[SalesRoleOrderByNestedInput!]	Sales role that sees the checklist item. Sorts by fields of the related record, listed in order of priority.
`stepChecklist`	[StepChecklistOrderByNestedInput!]	Checklist item the role is granted access to. Sorts by fields of the related record, listed in order of priority.
`salesRoleId`	OrderByEnum	Id of the sales role that sees the checklist item.
`stepChecklistId`	OrderByEnum	Id of the checklist item.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a StepChecklistSalesRoleRelation 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.
`salesRoleId`	ID	Id of the sales role that sees the checklist item.
`stepChecklistId`	ID	Id of the checklist item.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a new StepChecklistSalesRoleRelation 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.
`salesRoleId`	ID!	Id of the sales role that sees the checklist item.
`stepChecklistId`	ID!	Id of the checklist item.
`revision`	Int	Revision when entity was lastly changed.

DeleteStepChecklistSalesRoleRelationInput input clientMutationId: String, id: ID!

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

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

Id of a StepChecklistSalesRoleRelation 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.
`salesRoleId`	ID	Id of the sales role that sees the checklist item.
`stepChecklistId`	ID	Id of the checklist item.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateStepChecklistSalesRoleRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateStepChecklistSalesRoleRelation mutation.

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

CreateStepChecklistSalesRoleRelationPayload object stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationEntity, clientMutationId: String

Result of the createStepChecklistSalesRoleRelation mutation.

Field	Type	Description
`stepChecklistSalesRoleRelation`	StepChecklistSalesRoleRelationEntity	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).

DeleteStepChecklistSalesRoleRelationPayload object stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationEntity, clientMutationId: String

Result of the deleteStepChecklistSalesRoleRelation mutation.

Field	Type	Description
`stepChecklistSalesRoleRelation`	StepChecklistSalesRoleRelationEntity	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).

UpdateStepChecklistSalesRoleRelationPayload object stepChecklistSalesRoleRelation: StepChecklistSalesRoleRelationEntity, clientMutationId: String

Result of the updateStepChecklistSalesRoleRelation mutation.

Field	Type	Description
`stepChecklistSalesRoleRelation`	StepChecklistSalesRoleRelationEntity	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).