GraphQL RepositoriesprocessScheduledAction

`entities.processScheduledAction`

Read process scheduled action records with the processScheduledAction repository.

4 queries
0 mutations

Example: first three process scheduled action recordsGraphQLcURL

query FirstProcessScheduledActions {
  entities {
    processScheduledAction {
      getByCriteria(first: 3) {
        totalCount
        edges { node { id } }
      }
    }
  }
}

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 FirstProcessScheduledActions { entities { processScheduledAction { getByCriteria(first: 3) { totalCount edges { node { id } } } } } }"}'

Queries

Fields of entities { processScheduledAction { … } }.

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

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.

ProcessScheduledActionEntity object 16 fields: isDeleteProtected, id, actor, …

Action of an Automatizer process that is waiting to run for a record at a scheduled time.

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.
`actor`	ClientEntity	User whose change triggered the process run that scheduled this action.
`actorId`	ID	Id of the user whose change triggered the process run that scheduled this action.
`application`	ApplicationEntity	Application through which the change that triggered the process run was made; empty for changes made in Coevera itself.
`applicationId`	ID	Id of the application through which the triggering change was made; empty for changes made in Coevera itself.
`actionName`	String!	Name of the scheduled action as set in the process.
`triggeredDate`	DateTime!	Date and time the process run that scheduled this action started.
`scheduledDate`	DateTime!	Date and time the action is scheduled to run.
`entityId`	ID!	Id of the record whose change triggered the process run that scheduled this action.
`entityName`	EntityNameEnum!	Entity type of the triggering record; CustomEntity for a custom entity record (see entityApiName).
`entityApiName`	String	API name of the custom entity of the triggering record; empty for other entity types.
`process`	ProcessEntity	Process (automation) that scheduled this action.
`processId`	ID!	Id of the process that scheduled this action.
`processUrl`	String	Link that opens the process (automation) that scheduled this action in the Coevera web app. Empty when the link is not available to the caller.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

ProcessScheduledActionEntityConnection object pageInfo: PageInfo!, edges: [ProcessScheduledActionEntityEdge]!, totalCount: Int

Paginated list of ProcessScheduledAction records.

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

ProcessScheduledActionEntityEdge object node: ProcessScheduledActionEntity, cursor: String!

A Relay edge containing a ProcessScheduledActionEntity and its cursor.

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

EntityNameEnumFilterInput input eq: [EntityNameEnum!], NOT: EntityNameEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[EntityNameEnum!]	Matches any of the listed values.
`NOT`	EntityNameEnumFilterInput	Matches values that do not meet this condition.

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

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

Input field	Type	Description
`OR`	[ProcessScheduledActionFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ProcessScheduledActionFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ProcessScheduledActionFilterInput	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.
`actorId`	EntityFilterStringField	Id of the user whose change triggered the process run that scheduled this action.
`applicationId`	EntityFilterStringField	Id of the application through which the triggering change was made; empty for changes made in Coevera itself.
`actionName`	EntityFilterStringField	Name of the scheduled action as set in the process.
`triggeredDate`	EntityFilterDateTimeField	Date and time the process run that scheduled this action started.
`scheduledDate`	EntityFilterDateTimeField	Date and time the action is scheduled to run.
`entityId`	EntityFilterStringField	Id of the record whose change triggered the process run that scheduled this action.
`entityName`	EntityNameEnumFilterInput	Entity type of the triggering record; CustomEntity for a custom entity record (see entityApiName).
`entityApiName`	EntityFilterStringField	API name of the custom entity of the triggering record; empty for other entity types.
`processId`	EntityFilterStringField	Id of the process that scheduled this action.
`actor`	ClientFilterInput	User whose change triggered the process run that scheduled this action. Matches records where a related record meets these conditions.
`application`	ClientFilterInput	Application through which the change that triggered the process run was made; empty for changes made in Coevera itself. Matches records where a related record meets these conditions.
`process`	ProcessFilterInput	Process (automation) that scheduled this action. Matches records where a related record meets these conditions.

ProcessScheduledActionOrderByInput input Asc or Desc per field

Sorting of ProcessScheduledAction 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.
`actor`	[ClientOrderByNestedInput!]	User whose change triggered the process run that scheduled this action. Sorts by fields of the related record, listed in order of priority.
`actorId`	OrderByEnum	Id of the user whose change triggered the process run that scheduled this action.
`application`	[ClientOrderByNestedInput!]	Application through which the change that triggered the process run was made; empty for changes made in Coevera itself. Sorts by fields of the related record, listed in order of priority.
`applicationId`	OrderByEnum	Id of the application through which the triggering change was made; empty for changes made in Coevera itself.
`actionName`	OrderByEnum	Name of the scheduled action as set in the process.
`triggeredDate`	OrderByEnum	Date and time the process run that scheduled this action started.
`scheduledDate`	OrderByEnum	Date and time the action is scheduled to run.
`entityId`	OrderByEnum	Id of the record whose change triggered the process run that scheduled this action.
`entityApiName`	OrderByEnum	API name of the custom entity of the triggering record; empty for other entity types.
`process`	[ProcessOrderByNestedInput!]	Process (automation) that scheduled this action. Sorts by fields of the related record, listed in order of priority.
`processId`	OrderByEnum	Id of the process that scheduled this action.