ProcessMutations

No description

type ProcessMutations {
  createProcess(
    name: String!
    description: String!
  ): CreateProcessResultGql
  createWorkflow(
    processId: Long!
    name: String!
    description: String
    duplicateWorkflowId: Long
  ): WorkflowDataGql
  saveWorkflow(
    workflowData: WorkflowDataGqlInput!
  ): WorkflowDataGql
  archiveProcess(
    processId: Long!
  ): Boolean
  archiveWorkflow(
    workflowId: Long!
  ): Boolean
  runNodeInMemory(
    workflowData: WorkflowDataGqlInput!
    nodeName: String!
    previousRunNodes: [KVStringRunNodeGqlInput!]
    iterationLimit: Int
    currentNodeOnly: Boolean
    loopRunMode: String
    loopSelectorName: String
    loopSelectorIndex: Int
    loopSelectorKey: String
  ): RunWorkflowDataGql
  validateJsPackages(
    packages: [JsPackageInput!]!
  ): [JsPackageValidationResult!]
  updateProcessJsPackages(
    processId: Long!
    packages: [JsPackageInput!]!
  ): ProcessData
  updateProcessSettings(
    processId: Long!
    settings: ProcessSettingsInput!
  ): ProcessData
  setProcessPaused(
    processId: Long!
    paused: Boolean!
  ): ProcessData
  generateWebhookApiKey(
    webhookId: Long!
  ): String
  runProcess(
    processId: Long!
    triggerNodeName: String!
    payload: String
  ): Boolean
  cancelRun(
    runWorkflowId: Long!
  ): Boolean
  cancelInMemoryRun(
    runId: String!
  ): Boolean
  workflowFileDownloadUrl(
    publicId: String!
    source: String
  ): String
  requestWorkflowFileUploadUrl(
    fileName: String!
    contentType: String!
    declaredSize: Long!
  ): WorkflowFileUploadTicket
  commitWorkflowFileUpload(
    publicId: String!
  ): String
  detectCsvDialect(
    publicId: String!
  ): String
}

Fields

ProcessMutations.createProcess ● CreateProcessResultGql object

Create a new process with a default workflow

ProcessMutations.createProcess.name ● String! non-null scalar

ProcessMutations.createProcess.description ● String! non-null scalar

ProcessMutations.createWorkflow ● WorkflowDataGql object

Create a new workflow in a process, optionally duplicating an existing workflow

ProcessMutations.createWorkflow.processId ● Long! non-null scalar

ProcessMutations.createWorkflow.name ● String! non-null scalar

ProcessMutations.createWorkflow.description ● String scalar

ProcessMutations.createWorkflow.duplicateWorkflowId ● Long scalar

ProcessMutations.saveWorkflow ● WorkflowDataGql object

Save changes to a workflow's nodes and edges

ProcessMutations.saveWorkflow.workflowData ● WorkflowDataGqlInput! non-null input

ProcessMutations.archiveProcess ● Boolean scalar

Archive a process and all its workflows

ProcessMutations.archiveProcess.processId ● Long! non-null scalar

ProcessMutations.archiveWorkflow ● Boolean scalar

Archive a specific workflow

ProcessMutations.archiveWorkflow.workflowId ● Long! non-null scalar

ProcessMutations.runNodeInMemory ● RunWorkflowDataGql object

Execute a single node in memory for testing without persisting results

ProcessMutations.runNodeInMemory.workflowData ● WorkflowDataGqlInput! non-null input

ProcessMutations.runNodeInMemory.nodeName ● String! non-null scalar

ProcessMutations.runNodeInMemory.previousRunNodes ● [KVStringRunNodeGqlInput!] list input

ProcessMutations.runNodeInMemory.iterationLimit ● Int scalar

ProcessMutations.runNodeInMemory.currentNodeOnly ● Boolean scalar

ProcessMutations.runNodeInMemory.loopRunMode ● String scalar

ProcessMutations.runNodeInMemory.loopSelectorName ● String scalar

ProcessMutations.runNodeInMemory.loopSelectorIndex ● Int scalar

ProcessMutations.runNodeInMemory.loopSelectorKey ● String scalar

ProcessMutations.validateJsPackages ● [JsPackageValidationResult!] list object

Validate JavaScript packages for availability and version

ProcessMutations.validateJsPackages.packages ● [JsPackageInput!]! non-null input

ProcessMutations.updateProcessJsPackages ● ProcessData object

Update the JavaScript packages on a process (shared across all its workflow versions). Allowed even when releases are immutable.

ProcessMutations.updateProcessJsPackages.processId ● Long! non-null scalar

ProcessMutations.updateProcessJsPackages.packages ● [JsPackageInput!]! non-null input

ProcessMutations.updateProcessSettings ● ProcessData object

Update a process's operational settings (timeout, loop concurrency, failure notification), shared by all its workflow versions. Allowed even when releases are immutable.

ProcessMutations.updateProcessSettings.processId ● Long! non-null scalar

ProcessMutations.updateProcessSettings.settings ● ProcessSettingsInput! non-null input

ProcessMutations.setProcessPaused ● ProcessData object

Set the paused state of a process

ProcessMutations.setProcessPaused.processId ● Long! non-null scalar

ProcessMutations.setProcessPaused.paused ● Boolean! non-null scalar

ProcessMutations.generateWebhookApiKey ● String scalar

Generate (or regenerate) an API key for a webhook; returns the plaintext key once

ProcessMutations.generateWebhookApiKey.webhookId ● Long! non-null scalar

ProcessMutations.runProcess ● Boolean scalar

Manually run a process now through one of its trigger nodes. Authenticated by the caller's session and bypasses the paused state (pause only gates automated webhook/schedule triggers); records run history with a Manual source.

ProcessMutations.runProcess.processId ● Long! non-null scalar

ProcessMutations.runProcess.triggerNodeName ● String! non-null scalar

ProcessMutations.runProcess.payload ● String scalar

ProcessMutations.cancelRun ● Boolean scalar

Cancel a run: a queued run is dropped before it executes; a running run stops at the next node boundary.

ProcessMutations.cancelRun.runWorkflowId ● Long! non-null scalar

ProcessMutations.cancelInMemoryRun ● Boolean scalar

Cancel an in-memory (editor test) run by its run UUID; it stops at the next node boundary. These runs have no run history row, so they cannot be cancelled through cancelRun.

ProcessMutations.cancelInMemoryRun.runId ● String! non-null scalar

ProcessMutations.workflowFileDownloadUrl ● String scalar

Mint a short-lived signed download URL for a file produced by a workflow node. Takes the id from the file reference in a node's output. Org-scoped: holding a reference is not authority to read the file, so the URL is minted per request for an authenticated member of the owning organization and is never stored in run state, the run cache, or an AI context.

ProcessMutations.workflowFileDownloadUrl.publicId ● String! non-null scalar

ProcessMutations.workflowFileDownloadUrl.source ● String scalar

ProcessMutations.requestWorkflowFileUploadUrl ● WorkflowFileUploadTicket object

Sign a direct browser upload of a file for use in workflows, and record it pending. The browser POSTs the bytes straight to the bucket with the returned fields (the file part last) and then calls commitWorkflowFileUpload with the returned public id. Requires canBuildWorkflows; the file counts against the organization's storage quota and is reaped on the same 30-day clock as files produced by runs.

ProcessMutations.requestWorkflowFileUploadUrl.fileName ● String! non-null scalar

ProcessMutations.requestWorkflowFileUploadUrl.contentType ● String! non-null scalar

ProcessMutations.requestWorkflowFileUploadUrl.declaredSize ● Long! non-null scalar

ProcessMutations.commitWorkflowFileUpload ● String scalar

Verify an uploaded file landed and mark it committed, returning the file reference to use in expressions. The size declared when the upload was requested is a client claim; this checks the real object size.

ProcessMutations.commitWorkflowFileUpload.publicId ● String! non-null scalar

ProcessMutations.detectCsvDialect ● String scalar

Suggest a CSV dialect (delimiter, charset) by sampling the start of an uploaded file. A suggestion only — it pre-fills the editor's dialect form, and what is saved on the node is what runs. Returns null when nothing can be inferred confidently. Org-scoped like every other file read.

ProcessMutations.detectCsvDialect.publicId ● String! non-null scalar

Returned By

processes mutation