OBJECT
ProcessRepository
Read operations for Process records.
link GraphQL Schema definition
- type ProcessRepository {
- # Returns the record with the given id, or null when there is none. Deleted
- # records are returned as well.
- #
- # Arguments
- # entityId: Id of the record to return.
- (: ID!): ProcessEntity
- # Returns the records with the given ids; ids without a record are left out.
- # Deleted records are returned as well.
- #
- # Arguments
- # entityIds: Ids of the records to return.
- (: [ID!]!): [ProcessEntity!]!
- # Returns the records that match the filter, paged with limit and offset.
- #
- # Arguments
- # limit: Maximum number of records to return.
- # offset: Number of records to skip from the start of the result.
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- # includeDeleted: When true, deleted records are returned as
- # well. Defaults to false.
- (
- : Int,
- : Int,
- : ProcessFilterInput,
- : [ProcessOrderByInput!],
- : Boolean
- ): [ProcessEntity!]!
- # Returns the records that match the filter as a cursor-paginated connection.
- #
- # Arguments
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- # includeDeleted: When true, deleted records are returned as
- # well. Defaults to false.
- # 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.
- (
- : ProcessFilterInput,
- : [ProcessOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ProcessEntityConnection
- # Returns the ids of the fields of a record that changed after the given revision.
- # Returns an empty list for entities without change tracking.
- #
- # Arguments
- # id: Id of the record.
- # revision: Revision to compare against; only later changes are
- # returned.
- (
- : UUID!,
- : Int!
- ): [UUID!]!
- # Returns how many runs of the process succeeded, ended with a warning or failed,
- # bucketed by hour for the last 24 hours or by day for the last 7 or 14 days, in
- # the user's time zone. Buckets without runs are included with zero counts.
- #
- # Arguments
- # entityId: Id of the process.
- # interval: Time range of the timeline.
- (
- : ID!,
- : LastActivityInterval!
- ): ProcessTimelineResult!
- # Returns a page of processes filtered by owner, enabled state, status and tags,
- # in addition to the regular filter.
- #
- # Arguments
- # listingOptions: Owner, active/inactive, status and tag filters
- # applied to the list.
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- # 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.
- (
- : ProcessTabDataGridViewOptionsParams!,
- : ProcessFilterInput,
- : [ProcessOrderByInput!],
- : String,
- : String,
- : Int,
- : Int
- ): ProcessEntityConnection
- # Returns the processes that have actions scheduled to run later for any of the
- # selected records.
- #
- # Arguments
- # bulkFilter: Selection of records: explicit ids, a list result,
- # and ids to exclude.
- (
- : BulkOperationInput!
- ): [ProcessEntity!]!
- # Returns the processes that start the given process from one of their steps.
- #
- # Arguments
- # processId: Id of the triggered process.
- (: UUID!): [ProcessEntity!]!
- # Returns the most recent process runs that involved the record, either because
- # the record triggered the process or because a process action created or changed
- # it, newest first.
- #
- # Arguments
- # entityId: Id of the record.
- # entityName: Type of the record.
- # limit: Maximum number of records to return.
- (
- : UUID!,
- : EntityNameEnum!,
- : Int!
- ): [RecentExecutionItem!]!
- # Returns processes with a manual trigger that the current user is allowed to
- # start, according to each trigger's allowed users and units.
- #
- # Arguments
- # limit: Maximum number of records to return. Limit and offset
- # are applied before the allowed users and units are checked, so a page can hold
- # fewer records.
- # offset: Number of records to skip from the start of the result.
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- (
- : Int,
- : Int,
- : ProcessFilterInput,
- : [ProcessOrderByInput!]
- ): [ProcessEntity!]!
- # Converts process definitions into human-readable text descriptions, one per
- # input, in the same order. An empty definition gives an empty string and an
- # invalid one gives the text "error".
- #
- # Arguments
- # schemas: Process definitions as JSON strings, each conforming
- # to the ProcessSchema type.
- (
- : [String!]!
- ): [String!]!
- }