Skip to main content

ProcessQueries

No description

type ProcessQueries {
  listProcesses: [ProcessData!]
  getProcess(
    processId: Long
    publicId: String
  ): ProcessData
  getWorkflow(
    workflowId: Long
    publicId: String
  ): WorkflowDataGql
  listProcessRuns(
    processId: Long!
    phase: String
    from: String
    to: String
    limit: Int
    offset: Int
  ): [RunSummary!]
  getProcessRun(
    runWorkflowId: Long!
  ): RunWorkflowDataGql
  getProcessStats(
    processId: Long!
  ): ProcessStats
  getProcessRunCounts(
    processId: Long!
  ): RunQueueStats
  listWorkflows(
    processId: Long!
    released: Boolean!
    limit: Int!
    offset: Int!
  ): [Workflow!]
}

Fields

`ProcessQueries.listProcesses` ● `[ProcessData!]` list object

List all processes in the current organization

`ProcessQueries.getProcess` ● `ProcessData` object

Get a specific process by ID

`ProcessQueries.getProcess.processId` ● `Long` scalar

`ProcessQueries.getProcess.publicId` ● `String` scalar

`ProcessQueries.getWorkflow` ● `WorkflowDataGql` object

Get a specific workflow by ID with all its nodes and edges

`ProcessQueries.getWorkflow.workflowId` ● `Long` scalar

`ProcessQueries.getWorkflow.publicId` ● `String` scalar

`ProcessQueries.listProcessRuns` ● `[RunSummary!]` list object

List the production run history of a process, newest first

`ProcessQueries.listProcessRuns.processId` ● `Long!` non-null scalar

`ProcessQueries.listProcessRuns.phase` ● `String` scalar

`ProcessQueries.listProcessRuns.from` ● `String` scalar

`ProcessQueries.listProcessRuns.to` ● `String` scalar

`ProcessQueries.listProcessRuns.limit` ● `Int` scalar

`ProcessQueries.listProcessRuns.offset` ● `Int` scalar

`ProcessQueries.getProcessRun` ● `RunWorkflowDataGql` object

Get the full node-by-node detail of a single run

`ProcessQueries.getProcessRun.runWorkflowId` ● `Long!` non-null scalar

`ProcessQueries.getProcessStats` ● `ProcessStats` object

Aggregated stats for a process (task counts + recent run metrics) backing the process card tiles

`ProcessQueries.getProcessStats.processId` ● `Long!` non-null scalar

`ProcessQueries.getProcessRunCounts` ● `RunQueueStats` object

Run queue tiles: live queued/running + historical completed/failed counts and the configured queue size

`ProcessQueries.getProcessRunCounts.processId` ● `Long!` non-null scalar

`ProcessQueries.listWorkflows` ● `[Workflow!]` list object

Bounded workflow metadata for a process. released=true → published versions (newest first), released=false → drafts (recently edited first)

`ProcessQueries.listWorkflows.processId` ● `Long!` non-null scalar

`ProcessQueries.listWorkflows.released` ● `Boolean!` non-null scalar

`ProcessQueries.listWorkflows.limit` ● `Int!` non-null scalar

`ProcessQueries.listWorkflows.offset` ● `Int!` non-null scalar

Returned By

processes query

Fields
Returned By