{ "swagger": "2.0", "info": { "title": "Procedure executions service", "version": "0.1507.0", "description": "Send your API key as a bearer token: `Authorization: Bearer `." }, "tags": [ { "name": "ProcedureExecutionsService", "x-displayName": "Procedure executions service", "description": "Service for creating and managing procedure executions.", "x-errors": [ { "status": 404, "errorCode": "NOT_FOUND", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorNotFound", "message": "Procedure execution not found" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorProcNotFound", "message": "Procedure not found" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorNodeNotFound", "message": "Node not found" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorInvalidNode", "message": "Invalid node" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorInvalidGraph", "message": "Invalid procedure graph" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorInvalidStepTransition", "message": "Invalid step transition" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorInvalidSearchToken", "message": "Invalid search token" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "NominalProceduresExecutionsV1:ProcedureExecutionsServiceErrorInvalidStepUpdate", "message": "Invalid step update" } ] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/procedures/v1/executions/archive": { "post": { "operationId": "ProcedureExecutionsService_BatchArchiveProcedureExecutions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchArchiveProcedureExecutionsResponse" }, "x-example": { "procedureExecutionRids": [ "" ] } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BatchArchiveProcedureExecutionsRequest" }, "x-example": { "procedureExecutionRids": [ "" ] } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Batch archive procedure executions", "description": "Archive procedure executions" } }, "/procedures/v1/executions/batch-get-metadata": { "post": { "operationId": "ProcedureExecutionsService_BatchGetProcedureExecutionMetadata", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchGetProcedureExecutionMetadataResponse" }, "x-example": { "procedureExecutions": [ { "rid": "", "procedureRid": "", "procedureCommitId": "", "title": "", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true } ] } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BatchGetProcedureExecutionMetadataRequest" }, "x-example": { "procedureExecutionRids": [ "<procedure execution rids>" ] } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Batch get procedure execution metadata", "description": "Batch get procedure execution metadata" } }, "/procedures/v1/executions/procedures/{procedureRid}": { "post": { "operationId": "ProcedureExecutionsService_CreateProcedureExecution", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CreateProcedureExecutionResponse" }, "x-example": { "procedureExecution": { "rid": "<rid>", "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } } } } } }, "parameters": [ { "name": "procedureRid", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateProcedureExecutionBody" }, "x-example": { "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "startImmediately": true } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Create procedure execution", "description": "Create a new procedure execution from a procedure" } }, "/procedures/v1/executions/search": { "get": { "operationId": "ProcedureExecutionsService_SearchProcedureExecutions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchProcedureExecutionsResponse" }, "x-example": { "procedureExecutions": [ { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true } ], "nextPageToken": "<next page token>" } } }, "parameters": [ { "name": "query.searchText", "in": "query", "required": false, "type": "string" }, { "name": "query.label", "in": "query", "required": false, "type": "string" }, { "name": "query.property.name", "in": "query", "required": false, "type": "string" }, { "name": "query.property.value", "in": "query", "required": false, "type": "string" }, { "name": "query.workspace", "in": "query", "required": false, "type": "string" }, { "name": "query.procedureRid", "in": "query", "required": false, "type": "string" }, { "name": "query.commitId", "in": "query", "required": false, "type": "string" }, { "name": "query.createdBy", "in": "query", "required": false, "type": "string" }, { "name": "query.progressStatus", "in": "query", "required": false, "type": "string", "enum": [ "PROCEDURE_EXECUTION_PROGRESS_STATUS_UNSPECIFIED", "PROCEDURE_EXECUTION_PROGRESS_STATUS_NOT_STARTED", "PROCEDURE_EXECUTION_PROGRESS_STATUS_IN_PROGRESS", "PROCEDURE_EXECUTION_PROGRESS_STATUS_FINISHED", "PROCEDURE_EXECUTION_PROGRESS_STATUS_ABORTED" ], "default": "PROCEDURE_EXECUTION_PROGRESS_STATUS_UNSPECIFIED" }, { "name": "query.assetsFilter.assetRids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "query.assetsFilter.operator", "in": "query", "required": false, "type": "string", "enum": [ "OPERATOR_UNSPECIFIED", "OPERATOR_OR", "OPERATOR_AND" ], "default": "OPERATOR_UNSPECIFIED" }, { "name": "query.isArchived", "in": "query", "required": false, "type": "boolean" }, { "name": "sortOptions.isDescending", "description": "Defaults to descending", "in": "query", "required": false, "type": "boolean" }, { "name": "sortOptions.sortField", "in": "query", "required": true, "type": "string", "enum": [ "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UNSPECIFIED", "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_CREATED_AT", "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_STARTED_AT", "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_FINISHED_AT", "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UPDATED_AT" ], "default": "SEARCH_PROCEDURE_EXECUTIONS_SORT_FIELD_UNSPECIFIED" }, { "name": "pageSize", "description": "Page sizes greater than 1_000 will be rejected. Default pageSize is 100.", "in": "query", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "x-constraints": [ "From 1 to 1,000." ] }, { "name": "nextPageToken", "in": "query", "required": false, "type": "string" } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Search procedure executions", "description": "Search for procedure executions. The JSON transcoder ranks literal path segments above `/{...}` template captures, so the literal `/search` route wins over the `/{procedure_execution_rid}` template regardless of declaration order." } }, "/procedures/v1/executions/unarchive": { "post": { "operationId": "ProcedureExecutionsService_BatchUnarchiveProcedureExecutions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchUnarchiveProcedureExecutionsResponse" }, "x-example": { "procedureExecutionRids": [ "<procedure execution rids>" ] } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BatchUnarchiveProcedureExecutionsRequest" }, "x-example": { "procedureExecutionRids": [ "<procedure execution rids>" ] } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Batch unarchive procedure executions", "description": "Unarchive procedure executions" } }, "/procedures/v1/executions/{procedureExecutionRid}": { "get": { "operationId": "ProcedureExecutionsService_GetProcedureExecution", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetProcedureExecutionResponse" }, "x-example": { "procedureExecution": { "rid": "<rid>", "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } } }, "displayGraph": { "topLevelNodes": [ "<top level nodes>" ], "sectionToSortedChildren": { "<key>": { "nodeIds": [ "<node ids>" ] } } } } } }, "parameters": [ { "name": "procedureExecutionRid", "in": "path", "required": true, "type": "string" }, { "name": "includeDisplayGraph", "description": "If true, the display graph will be included in the response. Default is false.", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Get procedure execution", "description": "Get a procedure execution by its RID" } }, "/procedures/v1/executions/{procedureExecutionRid}/metadata": { "put": { "operationId": "ProcedureExecutionsService_UpdateProcedureExecutionMetadata", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UpdateProcedureExecutionMetadataResponse" }, "x-example": { "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true } } } }, "parameters": [ { "name": "procedureExecutionRid", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateProcedureExecutionMetadataBody" }, "x-example": { "title": "<title>", "description": "<description>", "commitId": "<commit id>", "labels": { "labels": [ "<labels>" ] }, "properties": { "properties": { "<key>": "<value>" } } } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Update procedure execution metadata", "description": "Update the metadata of a procedure execution" } }, "/procedures/v1/executions/{procedureExecutionRid}/steps/{stepId}/channel-capture-status": { "put": { "operationId": "ProcedureExecutionsService_UpdateStepChannelCaptureStatus", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UpdateStepChannelCaptureStatusResponse" }, "x-example": { "procedureExecution": { "rid": "<rid>", "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } } } } } }, "parameters": [ { "name": "procedureExecutionRid", "in": "path", "required": true, "type": "string" }, { "name": "stepId", "description": "The unique identifier of the execution step to update.", "in": "path", "required": true, "type": "string", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateStepChannelCaptureStatusBody" }, "x-example": { "channelCaptureStatus": { "outputFieldId": "<output field id>", "captureMoment": "CAPTURE_MOMENT_STEP_START", "inProgress": { "startedAt": "2026-01-01T00:00:00Z" } } } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Update step channel capture status", "description": "Called by the backend (channel capture executor) to merge a single channel-capture status into a step's channel_capture_statuses. Identity is (output_field_id, capture_moment); existing entries for that identity are replaced. Statuses are written incrementally as captures progress (in_progress -> terminal), so this RPC is expected to be called multiple times per capture." } }, "/procedures/v1/executions/{procedureExecutionRid}/steps/{stepId}/repeat": { "put": { "operationId": "ProcedureExecutionsService_RepeatStep", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/RepeatStepResponse" }, "x-example": { "procedureExecution": { "rid": "<rid>", "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } } } } } }, "parameters": [ { "name": "procedureExecutionRid", "in": "path", "required": true, "type": "string" }, { "name": "stepId", "description": "The unique identifier of the execution step to repeat/duplicate.", "in": "path", "required": true, "type": "string", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RepeatStepBody" }, "x-example": { "behavior": "REPEAT_STEP_BEHAVIOR_ISOLATED", "value": { "form": { "fields": [ { "asset": { "assetReference": { "rid": "<rid>" } } } ] } }, "autoProceedConfig": { "disabled": {} }, "targetState": { "inProgress": {} } } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Repeat step", "description": "Repeat a previously finished step in a procedure execution. This can only be done if the given step is in state SUCCEEDED, SKIPPED or ERRORED. Other state transitions are managed by the backend." } }, "/procedures/v1/executions/{procedureExecutionRid}/steps/{stepId}/update": { "put": { "operationId": "ProcedureExecutionsService_UpdateStep", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UpdateStepResponse" }, "x-example": { "procedureExecution": { "rid": "<rid>", "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } } } } } }, "parameters": [ { "name": "procedureExecutionRid", "in": "path", "required": true, "type": "string" }, { "name": "stepId", "description": "The unique identifier of the execution step to update.", "in": "path", "required": true, "type": "string", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateStepBody" }, "x-example": { "value": { "form": { "fields": [ { "asset": { "assetReference": { "rid": "<rid>" } } } ] } }, "autoProceedConfig": { "disabled": {} }, "targetState": { "inProgress": {} } } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Update step", "description": "Update the status of a step in a procedure execution. This can only be done if the step is NOT_STARTED, IN_PROGRESS, or SUBMITTED. Other state transitions are managed by the backend." } }, "/procedures/v1/executions/{procedureExecutionRid}/update": { "put": { "operationId": "ProcedureExecutionsService_UpdateProcedureExecution", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UpdateProcedureExecutionResponse" }, "x-example": { "procedureExecution": { "rid": "<rid>", "metadata": { "rid": "<rid>", "procedureRid": "<procedure rid>", "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "labels": [ "<labels>" ], "properties": { "<key>": "<value>" }, "createdBy": "<created by>", "createdAt": "2026-01-01T00:00:00Z", "updatedBy": "<updated by>", "updatedAt": "2026-01-01T00:00:00Z", "startedAt": "2026-01-01T00:00:00Z", "startedBy": "<started by>", "finishedAt": "2026-01-01T00:00:00Z", "finishedBy": "<finished by>", "abortedAt": "2026-01-01T00:00:00Z", "abortedBy": "<aborted by>", "failedAt": "2026-01-01T00:00:00Z", "failedBy": "<failed by>", "failedReason": "<failed reason>", "assetRids": [ "<asset rids>" ], "isArchived": true }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } } } } } }, "parameters": [ { "name": "procedureExecutionRid", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateProcedureExecutionBody" }, "x-example": { "title": "<title>", "description": "<description>", "commitId": "<commit id>", "labels": { "labels": [ "<labels>" ] }, "properties": { "properties": { "<key>": "<value>" } }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } }, "isAborted": true, "startedAt": "2026-01-01T00:00:00Z", "finishedAt": "2026-01-01T00:00:00Z" } } ], "tags": [ "ProcedureExecutionsService" ], "summary": "Update procedure execution", "description": "Heavy-handed update method for procedure execution." } } }, "definitions": { "AndSuccessCondition": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/SuccessConditionStatus" } } } }, "ApplyChecklistsResult": { "type": "object", "properties": { "dataReviewRids": { "type": "array", "items": { "type": "string" } } }, "description": "An ApplyChecklists action results in a list of DataReviewRids if successful." }, "ApplyWorkbookTemplatesResult": { "type": "object", "properties": { "workbookRids": { "type": "array", "items": { "type": "string" } } }, "description": "An ApplyWorkbookTemplates action results in a list of workbook RIDs if successful." }, "AssetFieldValue": { "type": "object", "properties": { "assetReference": { "$ref": "#/definitions/AssetReference" } }, "x-oneofs": [ { "fields": [ "assetReference" ], "required": false } ], "example": { "assetReference": { "rid": "string" } } }, "BatchArchiveProcedureExecutionsRequest": { "type": "object", "properties": { "procedureExecutionRids": { "type": "array", "items": { "type": "string" } } }, "example": { "procedureExecutionRids": [ "<procedure execution rids>" ] } }, "BatchArchiveProcedureExecutionsResponse": { "type": "object", "properties": { "procedureExecutionRids": { "type": "array", "items": { "type": "string" } } } }, "BatchGetProcedureExecutionMetadataRequest": { "type": "object", "properties": { "procedureExecutionRids": { "type": "array", "items": { "type": "string" } } }, "example": { "procedureExecutionRids": [ "<procedure execution rids>" ] } }, "BatchGetProcedureExecutionMetadataResponse": { "type": "object", "properties": { "procedureExecutions": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/ProcedureExecutionMetadata" } } } }, "BatchUnarchiveProcedureExecutionsRequest": { "type": "object", "properties": { "procedureExecutionRids": { "type": "array", "items": { "type": "string" } } }, "example": { "procedureExecutionRids": [ "<procedure execution rids>" ] } }, "BatchUnarchiveProcedureExecutionsResponse": { "type": "object", "properties": { "procedureExecutionRids": { "type": "array", "items": { "type": "string" } } } }, "CapturedValue": { "type": "object", "properties": { "doubleValue": { "type": "number", "format": "double" }, "intValue": { "type": "string", "format": "int64" }, "boolValue": { "type": "boolean" }, "stringValue": { "type": "string" } }, "x-oneofs": [ { "fields": [ "doubleValue", "intValue", "boolValue", "stringValue" ], "required": true } ], "description": "Set exactly one of the fields below.", "example": { "doubleValue": 1 } }, "ChannelCaptureFailed": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "failedAt": { "type": "string", "format": "date-time" }, "reason": { "$ref": "#/definitions/ChannelCaptureFailureReason" }, "errorMessage": { "type": "string", "description": "Free-text detail. Must not contain unsafe content — same conventions as other user-visible error_message fields on procedure executions. Capped to bound payload size; truncate at the producer if a longer detail is available.", "maxLength": 4096, "x-constraints": [ "At most 4,096 characters." ] } }, "description": "The capture terminated with a failure. The structured reason enum drives UI grouping and downstream alerting; error_message provides a free-text detail for operator debugging. Whether a failed capture transitions the containing step to ERRORED is a backend policy decision outside this message — do not assume failure always implies step ERRORED." }, "ChannelCaptureFailureReason": { "type": "string", "enum": [ "CHANNEL_CAPTURE_FAILURE_REASON_UNSPECIFIED", "CHANNEL_CAPTURE_FAILURE_REASON_DATA_SOURCE_NOT_FOUND", "CHANNEL_CAPTURE_FAILURE_REASON_CHANNEL_NOT_FOUND", "CHANNEL_CAPTURE_FAILURE_REASON_UNSUPPORTED_CHANNEL_TYPE", "CHANNEL_CAPTURE_FAILURE_REASON_TIMEOUT_NO_DATA", "CHANNEL_CAPTURE_FAILURE_REASON_INTERNAL_ERROR" ], "default": "CHANNEL_CAPTURE_FAILURE_REASON_UNSPECIFIED", "description": "Categorizes why a channel capture failed. New reasons should be added here as additional failure modes are recognized.\n\n - CHANNEL_CAPTURE_FAILURE_REASON_DATA_SOURCE_NOT_FOUND: The channel's data_source_ref could not be resolved to a concrete data source at execution time (e.g. the named ref is not present in the execution's data scopes or run data sources).\n - CHANNEL_CAPTURE_FAILURE_REASON_CHANNEL_NOT_FOUND: The data source was resolved but the named channel (with the configured tags, if any) does not exist on it, or its metadata could not be fetched.\n - CHANNEL_CAPTURE_FAILURE_REASON_UNSUPPORTED_CHANNEL_TYPE: The channel's data type cannot be represented by CapturedValue, or the channel's data type is unset. Permanent for this channel — re-running will not help.\n - CHANNEL_CAPTURE_FAILURE_REASON_TIMEOUT_NO_DATA: No data point arrived within the capture timeout window (subscription opened but yielded no value before the deadline).\n - CHANNEL_CAPTURE_FAILURE_REASON_INTERNAL_ERROR: Catch-all for backend / infrastructure failures that prevented capture — e.g. websocket connect/subscribe/stream failure, missing websocket configuration, downstream event creation failure, interrupt, or any other unexpected failure. See error_message for the specific cause.", "example": "CHANNEL_CAPTURE_FAILURE_REASON_DATA_SOURCE_NOT_FOUND" }, "ChannelCaptureInProgress": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" } }, "description": "The capture has been initiated (the value read / WebSocket subscription opened) but no terminal outcome has been written yet. The frontend can render a \"capturing...\" affordance from this state." }, "ChannelCaptureSkipReason": { "type": "string", "enum": [ "CHANNEL_CAPTURE_SKIP_REASON_UNSPECIFIED", "CHANNEL_CAPTURE_SKIP_REASON_RUN_SCOPED_UNSUPPORTED" ], "default": "CHANNEL_CAPTURE_SKIP_REASON_UNSPECIFIED", "description": "Categorizes why a channel capture was skipped without being attempted. Skipped statuses are soft outcomes and do not transition the step to ERRORED.\n\n - CHANNEL_CAPTURE_SKIP_REASON_RUN_SCOPED_UNSUPPORTED: The capture targets a run-scoped channel locator, which is not yet supported.", "example": "CHANNEL_CAPTURE_SKIP_REASON_RUN_SCOPED_UNSUPPORTED" }, "ChannelCaptureSkipped": { "type": "object", "properties": { "skippedAt": { "type": "string", "format": "date-time" }, "reason": { "$ref": "#/definitions/ChannelCaptureSkipReason" } }, "description": "The capture was intentionally not attempted because the system does not currently support this capture configuration and purposefully skips rather than fails." }, "ChannelCaptureStatus": { "type": "object", "properties": { "outputFieldId": { "type": "string", "description": "The output_field_id of the capture. Used together with capture_moment to identify which capture this status refers to.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "captureMoment": { "$ref": "#/definitions/CaptureMoment", "description": "Which step lifecycle moment this capture corresponds to. A given output_field_id may be captured at both step start and step completion, in which case there will be one ChannelCaptureStatus entry per moment. Must be a defined, non-UNSPECIFIED CaptureMoment — capture_moment is half of the identity key used for merging, so accepting the zero value would produce a bogus key." }, "inProgress": { "$ref": "#/definitions/ChannelCaptureInProgress" }, "succeeded": { "$ref": "#/definitions/ChannelCaptureSucceeded" }, "failed": { "$ref": "#/definitions/ChannelCaptureFailed" }, "skipped": { "$ref": "#/definitions/ChannelCaptureSkipped" } }, "description": "The status of a single channel capture attempt for a specific (output_field_id, capture_moment) pair on a step. Mirrors the lifecycle-oneof shape used by SuccessConditionStatus so that the frontend can render an in-progress \"capturing...\" affordance, a terminal value/error, or a soft skip (e.g. system limitation), all from a single self-describing message.\n\nIdentity within a step = (output_field_id, capture_moment). The backend merges incoming statuses by this key, replacing any previously written entry for that identity. The channel locator is not echoed here — consumers resolve it by looking up output_field_id in the step's capture config.\n\nSet exactly one of `inProgress`, `succeeded`, `failed`, `skipped`.", "x-oneofs": [ { "fields": [ "inProgress", "succeeded", "failed", "skipped" ], "required": true } ], "example": { "outputFieldId": "string", "captureMoment": "CAPTURE_MOMENT_STEP_START", "inProgress": { "startedAt": "2026-01-01T00:00:00Z" } } }, "ChannelCaptureSucceeded": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "capturedAt": { "type": "string", "format": "date-time" }, "value": { "$ref": "#/definitions/CapturedValue" } }, "description": "The capture terminated successfully with a value.", "required": [ "value" ] }, "ChannelValidationSuccessConditionStatus": { "type": "object", "properties": { "condition": { "$ref": "#/definitions/ChannelValidationSuccessCondition" }, "consecutiveMatches": { "type": "integer", "format": "int32", "description": "Persistence tracking state for channel validation conditions. Tracks consecutive successful evaluations for point_persistence." }, "firstSatisfiedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the condition first became satisfied. Used for time_persistence to track how long the condition has held true." } } }, "CheckboxFieldValue": { "type": "object", "properties": { "value": { "type": "boolean", "title": "Default to false if not set" } } }, "CompletionActionState": { "type": "object", "properties": { "notRun": { "$ref": "#/definitions/NotRun", "title": "The action was not run" }, "succeeded": { "$ref": "#/definitions/Succeeded", "title": "The action was run and succeeded. The result is available in CompletionActionStatus.result" }, "error": { "type": "string", "description": "The action was run and errored. This field contains the error message." }, "inProgress": { "$ref": "#/definitions/InProgress", "title": "The action execution is in progress" } }, "x-oneofs": [ { "fields": [ "notRun", "succeeded", "error", "inProgress" ], "required": true } ], "description": "Set exactly one of the fields below.", "example": { "notRun": {} } }, "InProgress": { "type": "object" }, "NotRun": { "type": "object" }, "Succeeded": { "type": "object" }, "CompletionActionStatus": { "type": "object", "properties": { "state": { "$ref": "#/definitions/CompletionActionState" }, "createEvent": { "$ref": "#/definitions/CreateEventResult" }, "createRun": { "$ref": "#/definitions/CreateRunResult" }, "applyWorkbookTemplates": { "$ref": "#/definitions/ApplyWorkbookTemplatesResult" }, "applyChecklists": { "$ref": "#/definitions/ApplyChecklistsResult" }, "updateRun": { "$ref": "#/definitions/UpdateRunResult", "description": "..." } }, "description": "The status of a completion action and its result (if any).\n\nSet at most one of `createEvent`, `createRun`, `applyWorkbookTemplates`, `applyChecklists`, `updateRun`.", "x-oneofs": [ { "fields": [ "createEvent", "createRun", "applyWorkbookTemplates", "applyChecklists", "updateRun" ], "required": false } ], "example": { "state": { "notRun": {} }, "createEvent": { "eventRid": "string" } } }, "CreateEventResult": { "type": "object", "properties": { "eventRid": { "type": "string" } }, "description": "A CreateEvent action results in an EventRid if successful." }, "CreateProcedureExecutionResponse": { "type": "object", "properties": { "procedureExecution": { "$ref": "#/definitions/ProcedureExecution" } } }, "CreateRunResult": { "type": "object", "properties": { "runRid": { "type": "string" } }, "description": "A CreateRun action results in a RunRid if successful." }, "DoubleFieldValue": { "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "ExecutionStepErrored": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time", "title": "Optional because a step can reach ERRORED without having been started" }, "startedBy": { "type": "string" }, "submittedAt": { "type": "string", "format": "date-time", "title": "Optional because a step can be errored before being submitted" }, "submittedBy": { "type": "string" }, "erroredAt": { "type": "string", "format": "date-time" }, "erroredBy": { "type": "string" }, "error": { "type": "string" }, "skippedAt": { "type": "string", "format": "date-time", "title": "Optional because a step could be skipped but then error while running completion actions" }, "skippedBy": { "type": "string" }, "skipReason": { "type": "string" }, "succeededAt": { "type": "string", "format": "date-time", "title": "Optional because a step can succeed but then error while running completion actions" }, "succeededBy": { "type": "string" } }, "description": "An execution step reaches the ERRORED state if something went wrong while trying to complete the step. This could be due to a badly configured procedure, an error/timeout in the completion condition, or an error/timeout in one of the completion actions. This is a terminal state, the step's values cannot be modified by the user." }, "ExecutionStepInProgress": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "startedBy": { "type": "string" } }, "description": "An execution step is in the IN_PROGRESS state once it has been started from NOT_STARTED, either manually or automatically. In this state, the step's values can be modified by the user." }, "ExecutionStepNotStarted": { "type": "object", "description": "All execution steps start in the NOT_STARTED state. In this state, the step's values can be modified by the user." }, "ExecutionStepSkipped": { "type": "object", "properties": { "skippedAt": { "type": "string", "format": "date-time" }, "skippedBy": { "type": "string" }, "skipReason": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "title": "Optional because a step can be skipped from the NOT_STARTED state before these are set" }, "startedBy": { "type": "string" }, "submittedAt": { "type": "string", "format": "date-time", "title": "Optional because a step can be skipped from the IN_PROGRESS state before these are set" }, "submittedBy": { "type": "string" } }, "description": "An execution step is in the SKIPPED state if it was skipped by a user. An execution step cannot be skipped if it is in a terminal state (SUCCEEDED or ERRORED). This is a terminal state, the step's values cannot be modified by the user." }, "ExecutionStepState": { "type": "object", "properties": { "notStarted": { "$ref": "#/definitions/ExecutionStepNotStarted" }, "inProgress": { "$ref": "#/definitions/ExecutionStepInProgress" }, "submitted": { "$ref": "#/definitions/ExecutionStepSubmitted" }, "skipped": { "$ref": "#/definitions/ExecutionStepSkipped", "title": "Terminal states below" }, "succeeded": { "$ref": "#/definitions/ExecutionStepSucceeded" }, "errored": { "$ref": "#/definitions/ExecutionStepErrored" } }, "description": "The read-side state for an execution step. Here is the state machine: All steps start in the NOT_STARTED state. From NOT_STARTED, a step can transition to IN_PROGRESS or SKIPPED.\n- Transitioning to IN_PROGRESS can be done manually by a user or automatically if auto-start is enabled. This transition can only happen if the step's dependencies are in a completed state (SUCCEEDED or SKIPPED) From IN_PROGRESS, a step can transition to SUBMITTED or SKIPPED.\n- Transitioning to SUBMITTED can be done manually by a user or automatically if auto-proceed is enabled. This transition can only happen if the step's content has its required values set.\n- Transitioning to SKIPPED can be done manually by a user. From SUBMITTED, a step can transition to SUCCEEDED, ERRORED, or SKIPPED.\n- Transitioning to SUCCEEDED or ERRORED is done by the backend after monitoring the completion condition (if any) and executing the completion actions (if any).\n- Transitioning to SKIPPED can be done manually by a user.\n\nSet exactly one of the fields below.", "x-oneofs": [ { "fields": [ "notStarted", "inProgress", "submitted", "skipped", "succeeded", "errored" ], "required": true } ], "example": { "notStarted": {} } }, "ExecutionStepSubmitted": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "startedBy": { "type": "string" }, "submittedAt": { "type": "string", "format": "date-time" }, "submittedBy": { "type": "string" } }, "description": "An execution step is in the SUBMITTED state once it has been submitted from the IN_PROGRESS state, either manually or automatically. In this state, the step's values are considered submitted and cannot be modified by the user. In this state, the backend will monitor the completion condition (if any) and execute the completion actions (if any) once the condition is satisfied." }, "ExecutionStepSucceeded": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "startedBy": { "type": "string" }, "submittedAt": { "type": "string", "format": "date-time" }, "submittedBy": { "type": "string" }, "succeededAt": { "type": "string", "format": "date-time" }, "succeededBy": { "type": "string" } }, "description": "An execution step reaches the SUCCEEDED state if all conditions were met and all actions successfully ran. This is a terminal state, the step's values cannot be modified by the user." }, "FieldOutput": { "type": "object", "properties": { "assetRid": { "type": "string", "title": "If a global field is not yet defined, I think it's just not present in the global_fields map option (buf.validate.oneof) = {required: true};" }, "stringValue": { "type": "string" }, "doubleValue": { "type": "number", "format": "double" }, "booleanValue": { "type": "boolean" }, "intValue": { "type": "string", "format": "int64" }, "stringsValue": { "$ref": "#/definitions/Strings" }, "ingestJobRid": { "type": "string" }, "runRid": { "type": "string" }, "fileUploadValue": { "$ref": "#/definitions/FileUploadFieldValue" }, "multiFileUploadValue": { "$ref": "#/definitions/MultiFileUploadFieldValue" } }, "title": "This is different from FormFieldValue in that this represents the resolved value after the step has been completed. Eg, this would contain an AssetRid while the FormFieldValue could contain an AssetReference", "x-oneofs": [ { "fields": [ "assetRid", "stringValue", "doubleValue", "booleanValue", "intValue", "stringsValue", "ingestJobRid", "runRid", "fileUploadValue", "multiFileUploadValue" ], "required": false } ], "description": "Set at most one of the fields below.", "example": { "assetRid": "string" } }, "FileUploadFieldValue": { "type": "object", "properties": { "s3Upload": { "$ref": "#/definitions/S3UploadFileValue" } }, "title": "Corresponds to usage of the upload api", "x-oneofs": [ { "fields": [ "s3Upload" ], "required": false } ], "example": { "s3Upload": { "s3Path": "string", "fileName": "string", "fileType": "string" } } }, "FormFieldValue": { "type": "object", "properties": { "asset": { "$ref": "#/definitions/AssetFieldValue" }, "checkbox": { "$ref": "#/definitions/CheckboxFieldValue" }, "text": { "$ref": "#/definitions/TextFieldValue" }, "int": { "$ref": "#/definitions/IntFieldValue" }, "double": { "$ref": "#/definitions/DoubleFieldValue" }, "singleEnum": { "$ref": "#/definitions/SingleEnumFieldValue" }, "multiEnum": { "$ref": "#/definitions/MultiEnumFieldValue" }, "fileUpload": { "$ref": "#/definitions/FileUploadFieldValue" }, "multiFileUpload": { "$ref": "#/definitions/MultiFileUploadFieldValue" } }, "description": "The value chosen for a form field. This differs from FieldOutput in that this should map 1:1 with FormField types, while FieldOutput contains the resolved values after the execution step is complete.\n\nSet exactly one of the fields below.", "x-oneofs": [ { "fields": [ "asset", "checkbox", "text", "int", "double", "singleEnum", "multiEnum", "fileUpload", "multiFileUpload" ], "required": true } ], "example": { "asset": { "assetReference": { "rid": "string" } } } }, "FormStepValue": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/FormFieldValue" } } } }, "GetProcedureExecutionResponse": { "type": "object", "properties": { "procedureExecution": { "$ref": "#/definitions/ProcedureExecution" }, "displayGraph": { "$ref": "#/definitions/ProcedureDisplayGraph", "description": "Included if include_display_graph was set to true. Note that this is the procedure template's display graph, not the execution graph." } } }, "IntFieldValue": { "type": "object", "properties": { "value": { "type": "string", "format": "int64" } } }, "MultiEnumFieldValue": { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "title": "Default to empty list if not set" } } }, "MultiFileUploadFieldValue": { "type": "object", "properties": { "uploads": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/FileUploadFieldValue" }, "title": "The list of uploads" } } }, "ProcedureExecution": { "type": "object", "properties": { "rid": { "type": "string" }, "metadata": { "$ref": "#/definitions/ProcedureExecutionMetadata" }, "state": { "$ref": "#/definitions/ProcedureExecutionState" } } }, "ProcedureExecutionMetadata": { "type": "object", "properties": { "rid": { "type": "string" }, "procedureRid": { "type": "string", "description": "The procedure template rid this execution is based on." }, "procedureCommitId": { "type": "string", "description": "The commit ID of the procedure template this execution is based on. This can be overridden at the node level for individual nodes." }, "title": { "type": "string", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "description": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "properties": { "type": "object", "additionalProperties": { "type": "string" } }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time", "description": "Will be unset until the execution transitions from NOT_STARTED to IN_PROGRESS." }, "startedBy": { "type": "string" }, "finishedAt": { "type": "string", "format": "date-time", "description": "Will be unset until the execution transitions from IN_PROGRESS to a terminal state." }, "finishedBy": { "type": "string" }, "abortedAt": { "type": "string", "format": "date-time", "description": "Will be true/set if the execution is the ABORTED terminal state." }, "abortedBy": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time", "description": "Will be set if the execution is in the ERRORED terminal state." }, "failedBy": { "type": "string" }, "failedReason": { "type": "string" }, "assetRids": { "type": "array", "items": { "type": "string" }, "description": "Assets which this execution has acted on in completed steps (e.g. through an event creation action)." }, "isArchived": { "type": "boolean" } } }, "ProcedureExecutionNode": { "type": "object", "properties": { "section": { "$ref": "#/definitions/ProcedureExecutionSectionNode", "description": "A section node is a visual grouping of other sections and steps. Execution sections are static and do not have execution state." }, "step": { "$ref": "#/definitions/ProcedureExecutionStepNode", "description": "Execution steps are the interactive steps in a procedure." } }, "description": "A procedure execution node is either a section or a step.\n\nSet exactly one of the fields below.", "x-oneofs": [ { "fields": [ "section", "step" ], "required": true } ], "example": { "section": { "id": "string", "templateNodeId": "string", "title": "string", "description": "string", "templateCommitId": "string" } } }, "ProcedureExecutionSectionNode": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of this execution node.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "templateNodeId": { "type": "string", "description": "Unique identifier of the template node this execution node is based on.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "title": { "type": "string", "description": "Title of this section. Uses the template section's title and cannot be changed in execution.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "description": { "type": "string", "description": "Description of this section. Uses the template section's description and cannot be changed in execution." }, "templateCommitId": { "type": "string", "description": "If set, the commit ID of the procedure template this section is based on. Otherwise, the section is based on the template commit specified at the top level of the execution." } }, "description": "A section node is a visual grouping of other sections and steps." }, "ProcedureExecutionState": { "type": "object", "properties": { "globalFields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/FieldOutput" }, "description": "The current values for the global fields in the procedure." }, "nodes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ProcedureExecutionNode" }, "description": "A map from execution node ID to the execution node." }, "sectionEdges": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NodeList" }, "description": "Section edges represent the visual grouping of sections and steps. All keys are IDs for section nodes, and all values are lists of IDs for section or step nodes. { A, [B, C] } means that section A visually groups nodes B and C together." }, "stepEdges": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NodeList" }, "title": "Step edges represent the dependencies between steps. All keys and values are IDs for step nodes. { A, [B, C] } means that steps B and C depend on step A to complete to be started" } }, "description": "ProcedureExecutionState is the state of an executing procedure." }, "ProcedureExecutionStepNode": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of this execution node.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "templateNodeId": { "type": "string", "description": "Unique identifier of the template node this execution node is based on.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "isOutdated": { "type": "boolean", "description": "Execution steps become \"outdated\" once any upstream steps are re-run An outdated execution step should not be further modified." }, "state": { "$ref": "#/definitions/ExecutionStepState", "description": "The current status of the step along with metadata about the status transitions." }, "value": { "$ref": "#/definitions/StepContentValue", "description": "The current value for the content of the step." }, "autoProceedConfig": { "$ref": "#/definitions/AutoProceedConfig", "description": "Whether the step has auto-proceed enabled." }, "successConditionStatus": { "$ref": "#/definitions/SuccessConditionStatus", "description": "Completion_condition_status is the status of the completion condition for the step The backend manages this property and will update it while it monitors the completion_condition if set. This property will be unset if no completion_condition is set on the step or if the execution step's contents has not been submitted yet." }, "completionActionStatuses": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/CompletionActionStatus" }, "description": "Completion_action_statuses are the status of the completion actions for the step The backend manages this property and will update it after performing completion_actions." }, "outputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/FieldOutput" }, "title": "Outputs are the values of the fields within this step, set by the backend after the step has reached the SUCCEEDED state. The backend will know how to introspect the node and determine these values, for example looking for form fields with ids in a FormStep. These outputs can be consumed by other steps later in the procedure by referencing `{output_id}:{field_id}`" }, "templateCommitId": { "type": "string", "description": "If set, the commit ID of the procedure template this step is based on. Otherwise, the step is based on the template commit specified at the top level of the execution." }, "channelCaptureStatuses": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/ChannelCaptureStatus" }, "description": "Channel capture statuses are the per-(output_field_id, capture_moment) statuses of the channel captures configured for this step. The backend manages this property and writes entries incrementally as captures progress through their lifecycle." } }, "description": "Execution steps are the interactive steps in a procedure." }, "CreateProcedureExecutionBody": { "type": "object", "properties": { "procedureCommitId": { "type": "string" }, "title": { "type": "string", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "description": { "type": "string" }, "startImmediately": { "type": "boolean" } }, "example": { "procedureCommitId": "<procedure commit id>", "title": "<title>", "description": "<description>", "startImmediately": true } }, "RepeatStepBody": { "type": "object", "properties": { "behavior": { "$ref": "#/definitions/RepeatStepBehavior", "description": "Behavior for how repeating the step will affect dependants." }, "value": { "$ref": "#/definitions/StepContentValue", "description": "Setting the value of the step's content." }, "autoProceedConfig": { "$ref": "#/definitions/AutoProceedConfig", "description": "Set whether the step has auto-proceed enabled." }, "targetState": { "$ref": "#/definitions/TargetStepStateRequest", "description": "Setting the state of the step. This will occur after the other updates in this request." } }, "example": { "behavior": "REPEAT_STEP_BEHAVIOR_ISOLATED", "value": { "form": { "fields": [ { "asset": { "assetReference": { "rid": "<rid>" } } } ] } }, "autoProceedConfig": { "disabled": {} }, "targetState": { "inProgress": {} } } }, "UpdateProcedureExecutionBody": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "commitId": { "type": "string" }, "labels": { "$ref": "#/definitions/LabelUpdateWrapper" }, "properties": { "$ref": "#/definitions/PropertyUpdateWrapper" }, "state": { "$ref": "#/definitions/ProcedureExecutionState" }, "isAborted": { "type": "boolean" }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" } }, "example": { "title": "<title>", "description": "<description>", "commitId": "<commit id>", "labels": { "labels": [ "<labels>" ] }, "properties": { "properties": { "<key>": "<value>" } }, "state": { "globalFields": { "<key>": { "assetRid": "<asset rid>" } }, "nodes": { "<key>": { "section": { "id": "<id>", "templateNodeId": "<template node id>", "title": "<title>", "description": "<description>", "templateCommitId": "<template commit id>" } } }, "sectionEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } }, "stepEdges": { "<key>": { "nodeIds": [ "<node ids>" ] } } }, "isAborted": true, "startedAt": "2026-01-01T00:00:00Z", "finishedAt": "2026-01-01T00:00:00Z" } }, "UpdateProcedureExecutionMetadataBody": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "commitId": { "type": "string" }, "labels": { "$ref": "#/definitions/LabelUpdateWrapper" }, "properties": { "$ref": "#/definitions/PropertyUpdateWrapper" } }, "example": { "title": "<title>", "description": "<description>", "commitId": "<commit id>", "labels": { "labels": [ "<labels>" ] }, "properties": { "properties": { "<key>": "<value>" } } } }, "UpdateStepBody": { "type": "object", "properties": { "value": { "$ref": "#/definitions/StepContentValue", "description": "Setting the value of the step's content. This is only allowed if the step is NOT_STARTED or IN_PROGRESS." }, "autoProceedConfig": { "$ref": "#/definitions/AutoProceedConfig", "description": "Set whether the step has auto-proceed enabled. This is only allowed if the step is NOT_STARTED. or IN_PROGRESS." }, "targetState": { "$ref": "#/definitions/TargetStepStateRequest", "description": "Setting the state of the step. This will occur after the other updates in this request." } }, "example": { "value": { "form": { "fields": [ { "asset": { "assetReference": { "rid": "<rid>" } } } ] } }, "autoProceedConfig": { "disabled": {} }, "targetState": { "inProgress": {} } } }, "UpdateStepChannelCaptureStatusBody": { "type": "object", "properties": { "channelCaptureStatus": { "$ref": "#/definitions/ChannelCaptureStatus", "description": "The status to merge into the step's channel_capture_statuses, identified by (output_field_id, capture_moment). Replaces any previously written entry with the same identity." } }, "example": { "channelCaptureStatus": { "outputFieldId": "<output field id>", "captureMoment": "CAPTURE_MOMENT_STEP_START", "inProgress": { "startedAt": "2026-01-01T00:00:00Z" } } } }, "RepeatStepBehavior": { "type": "string", "enum": [ "REPEAT_STEP_BEHAVIOR_UNSPECIFIED", "REPEAT_STEP_BEHAVIOR_ISOLATED" ], "default": "REPEAT_STEP_BEHAVIOR_UNSPECIFIED", "title": "- REPEAT_STEP_BEHAVIOR_ISOLATED: The targeted step will be repeated, but the original graph will be preserved and only direct children will be checked for state updates", "example": "REPEAT_STEP_BEHAVIOR_ISOLATED" }, "RepeatStepResponse": { "type": "object", "properties": { "procedureExecution": { "$ref": "#/definitions/ProcedureExecution" } } }, "S3UploadFileValue": { "type": "object", "properties": { "s3Path": { "type": "string", "title": "The S3 path where the uploaded file is stored", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "fileName": { "type": "string", "title": "The original filename of the uploaded file", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "fileType": { "type": "string", "title": "The MIME type of the uploaded file Following the convention of https://developer.mozilla.org/en-US/docs/Web/API/Blob/type (from which the File api inherits, we will accept an empty string)" } } }, "SearchProcedureExecutionsResponse": { "type": "object", "properties": { "procedureExecutions": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/ProcedureExecutionMetadata" } }, "nextPageToken": { "type": "string" } } }, "SelectOrCreateAssetStepValue": { "type": "object", "properties": { "assetReference": { "$ref": "#/definitions/AssetReference", "description": "The asset that was selected / created by the client. This must be populated for the step to be submitted." } } }, "SingleEnumFieldValue": { "type": "object", "properties": { "value": { "type": "string", "title": "Default to empty string if not set" } } }, "StartIngestStepValue": { "type": "object", "properties": { "ingestJobRid": { "type": "string", "description": "The RID of the ingest job that was started by the client. This must be populated for the step to be submitted." } } }, "StepContentValue": { "type": "object", "properties": { "form": { "$ref": "#/definitions/FormStepValue" }, "startIngest": { "$ref": "#/definitions/StartIngestStepValue" }, "selectOrCreateAsset": { "$ref": "#/definitions/SelectOrCreateAssetStepValue" }, "wait": { "$ref": "#/definitions/WaitStepValue", "description": "..." } }, "description": "The value for a step's content. Should match the ProcedureStepNode type.\n\nSet exactly one of the fields below.", "x-oneofs": [ { "fields": [ "form", "startIngest", "selectOrCreateAsset", "wait" ], "required": true } ], "example": { "form": { "fields": [ { "asset": { "assetReference": { "rid": "string" } } } ] } } }, "StepErroredRequest": { "type": "object", "properties": { "errorReason": { "type": "string" } } }, "StepInProgressRequest": { "type": "object" }, "StepSkippedRequest": { "type": "object", "properties": { "skipReason": { "type": "string" } } }, "StepSubmittedRequest": { "type": "object" }, "Strings": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "SuccessConditionCanceled": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "canceledAt": { "type": "string", "format": "date-time" } } }, "SuccessConditionFailed": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "failedAt": { "type": "string", "format": "date-time" }, "failureReason": { "type": "string" } } }, "SuccessConditionInProgress": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" } } }, "SuccessConditionSatisfied": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time" }, "satisfiedAt": { "type": "string", "format": "date-time" } } }, "SuccessConditionStatus": { "type": "object", "properties": { "and": { "$ref": "#/definitions/AndSuccessCondition" }, "timer": { "$ref": "#/definitions/TimerSuccessCondition" }, "ingestJob": { "$ref": "#/definitions/IngestJobSuccessCondition" }, "channelValidation": { "$ref": "#/definitions/ChannelValidationSuccessConditionStatus" }, "webhook": { "$ref": "#/definitions/WebhookConditionStatus", "title": "OrSuccessConditionOrStatus or = 5;" }, "inProgress": { "$ref": "#/definitions/SuccessConditionInProgress" }, "satisfied": { "$ref": "#/definitions/SuccessConditionSatisfied" }, "failed": { "$ref": "#/definitions/SuccessConditionFailed" }, "canceled": { "$ref": "#/definitions/SuccessConditionCanceled" }, "submitted": { "$ref": "#/definitions/SuccessConditionSubmitted" } }, "title": "Represents the current status of one or more nested completion conditions. Mirrors the recursive SuccessCondition in nominal.procedures.v1", "x-oneofs": [ { "fields": [ "and", "timer", "ingestJob", "channelValidation", "webhook" ], "required": true }, { "fields": [ "inProgress", "satisfied", "failed", "canceled", "submitted" ], "required": true } ], "description": "Set exactly one of `and`, `timer`, `ingestJob`, `channelValidation`, `webhook`. Set exactly one of `inProgress`, `satisfied`, `failed`, `canceled`, `submitted`.", "example": { "and": { "conditions": [] }, "inProgress": { "startedAt": "2026-01-01T00:00:00Z" } } }, "SuccessConditionSubmitted": { "type": "object", "properties": { "submittedAt": { "type": "string", "format": "date-time" } } }, "TargetStepStateRequest": { "type": "object", "properties": { "inProgress": { "$ref": "#/definitions/StepInProgressRequest" }, "submitted": { "$ref": "#/definitions/StepSubmittedRequest" }, "skipped": { "$ref": "#/definitions/StepSkippedRequest" }, "errored": { "$ref": "#/definitions/StepErroredRequest" } }, "description": "A request to update the state of an execution step.\n\nSet exactly one of the fields below.", "x-oneofs": [ { "fields": [ "inProgress", "submitted", "skipped", "errored" ], "required": true } ], "example": { "inProgress": {} } }, "TextFieldValue": { "type": "object", "properties": { "value": { "type": "string", "title": "Default to empty string if not set" } } }, "UpdateProcedureExecutionMetadataResponse": { "type": "object", "properties": { "metadata": { "$ref": "#/definitions/ProcedureExecutionMetadata" } } }, "UpdateProcedureExecutionResponse": { "type": "object", "properties": { "procedureExecution": { "$ref": "#/definitions/ProcedureExecution" } } }, "UpdateRunResult": { "type": "object", "properties": { "runRids": { "type": "array", "items": { "type": "string" } } }, "description": "An UpdateRun action results in the list of RunRids that were updated." }, "UpdateStepChannelCaptureStatusResponse": { "type": "object", "properties": { "procedureExecution": { "$ref": "#/definitions/ProcedureExecution" } } }, "UpdateStepResponse": { "type": "object", "properties": { "procedureExecution": { "$ref": "#/definitions/ProcedureExecution" } } }, "WaitStepValue": { "type": "object" }, "WebhookConditionStatus": { "type": "object", "properties": { "condition": { "$ref": "#/definitions/WebhookSuccessCondition", "title": "The original webhook condition configuration being monitored" }, "deliveryAttempts": { "type": "integer", "format": "int32", "title": "Number of delivery attempts made so far", "minimum": 0, "x-constraints": [ "At least 0." ] }, "lastAttemptTime": { "type": "string", "format": "date-time", "title": "Timestamp of the last delivery attempt" }, "nextRetryTime": { "type": "string", "format": "date-time", "title": "Timestamp when the next retry should be attempted (null if no retry scheduled)" }, "lastDeliveryId": { "type": "string", "title": "Unique ID of the last delivery attempt (unset if no attempts made yet) Generated per-attempt to correlate webhook deliveries with external system logs" }, "lastHttpStatus": { "type": "integer", "format": "int32", "title": "HTTP status code from the last delivery attempt", "minimum": 100, "maximum": 599, "x-constraints": [ "From 100 to 599." ] }, "lastErrorMessage": { "type": "string", "title": "Error message from the last delivery attempt (if failed)" }, "startedAt": { "type": "string", "format": "date-time", "title": "Timestamp when webhook condition evaluation started" }, "terminalFailureReason": { "$ref": "#/definitions/WebhookFailureReason", "description": "Terminal failure reason for this webhook condition. Only set when the condition transitions to FAILED status. Remains unset during retries (use last_error_message for intermediate failures)." } }, "description": "Status tracking for webhook success conditions. Tracks delivery attempts, retry timing, and the last response from the external system. Note: Secret management for retries is handled internally in workflow state, not exposed in this public API message." }, "WebhookFailureReason": { "type": "string", "enum": [ "WEBHOOK_FAILURE_REASON_UNSPECIFIED", "WEBHOOK_FAILURE_REASON_CLIENT_ERROR", "WEBHOOK_FAILURE_REASON_SERVER_ERROR_MAX_RETRIES_EXCEEDED", "WEBHOOK_FAILURE_REASON_TIMEOUT_MAX_RETRIES_EXCEEDED", "WEBHOOK_FAILURE_REASON_OVERALL_TIMEOUT_EXCEEDED", "WEBHOOK_FAILURE_REASON_NETWORK_ERROR_MAX_RETRIES_EXCEEDED", "WEBHOOK_FAILURE_REASON_PAYLOAD_ERROR", "WEBHOOK_FAILURE_REASON_REDIRECT_LOOP", "WEBHOOK_FAILURE_REASON_INTEGRATION_CONFIG_ERROR" ], "default": "WEBHOOK_FAILURE_REASON_UNSPECIFIED", "description": "Categorizes why a webhook success condition failed. This enum represents terminal failure states - failures that caused the condition to permanently fail.\n\n - WEBHOOK_FAILURE_REASON_UNSPECIFIED: Unspecified/unknown failure reason. Should not be used in normal operation.\n - WEBHOOK_FAILURE_REASON_CLIENT_ERROR: External system returned 4XX client error (permanent failure, no retry attempted). Indicates misconfiguration or invalid request that won't succeed on retry. Common causes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found.\n - WEBHOOK_FAILURE_REASON_SERVER_ERROR_MAX_RETRIES_EXCEEDED: External system returned 5XX server error and max retries were exhausted. Server errors are typically transient and retries were attempted. Common causes: 500 Internal Server Error, 502 Bad Gateway, 503 Service Unavailable.\n - WEBHOOK_FAILURE_REASON_TIMEOUT_MAX_RETRIES_EXCEEDED: Individual HTTP request timed out and max retries were exhausted. The external system didn't respond within the per-request timeout window.\n - WEBHOOK_FAILURE_REASON_OVERALL_TIMEOUT_EXCEEDED: Overall condition timeout exceeded before receiving successful 2xx response. The webhook delivery config's timeout_seconds was reached. This can occur even if individual requests completed (returned responses) but took too long cumulatively between retry delays, without receiving 2xx.\n - WEBHOOK_FAILURE_REASON_NETWORK_ERROR_MAX_RETRIES_EXCEEDED: Network-level failure prevented request delivery and max retries were exhausted. Common causes: DNS resolution failure, connection refused, TLS handshake failure.\n - WEBHOOK_FAILURE_REASON_PAYLOAD_ERROR: Template rendering or payload serialization failed (permanent failure). The payload_template could not be rendered to valid JSON. Common causes: Invalid Handlebars syntax, circular references, invalid JSON after rendering.\n - WEBHOOK_FAILURE_REASON_REDIRECT_LOOP: Too many redirects encountered (typically indicates redirect loop). Follows HTTP standard - most clients limit to 20 redirects.\n - WEBHOOK_FAILURE_REASON_INTEGRATION_CONFIG_ERROR: Integration configuration is invalid or missing required fields. Common causes: Integration RID not found, missing URL, invalid HMAC config.", "example": "WEBHOOK_FAILURE_REASON_CLIENT_ERROR" }, "AssetReference": { "type": "object", "properties": { "rid": { "type": "string", "title": "a constant AssetRid" }, "fieldId": { "type": "string", "description": "The field reference that will contain an AssetRid value. The execution will fail if the field is not set but the value is accessed." } }, "title": "A reference to a single asset", "x-oneofs": [ { "fields": [ "rid", "fieldId" ], "required": true } ], "description": "Set exactly one of the fields below.", "example": { "rid": "string" } }, "AutoProceedConfig": { "type": "object", "properties": { "disabled": { "$ref": "#/definitions/Disabled", "title": "The step will not be automatically completed" }, "enabled": { "$ref": "#/definitions/Enabled", "description": "The step will automatically submit the step contents once the requirements are met and begin the transition to either PASSED or ERRORED." } }, "description": "AutoProceedConfig is a configuration that determines whether a step should automatically proceed (submit the contents and check success_conditions) when some set of criteria are met. By default this will be `disabled`.\n\nSet exactly one of the fields below.", "x-oneofs": [ { "fields": [ "disabled", "enabled" ], "required": true } ], "example": { "disabled": {} } }, "Disabled": { "type": "object" }, "Enabled": { "type": "object" }, "CaptureMoment": { "type": "string", "enum": [ "CAPTURE_MOMENT_UNSPECIFIED", "CAPTURE_MOMENT_STEP_START", "CAPTURE_MOMENT_STEP_COMPLETION" ], "default": "CAPTURE_MOMENT_UNSPECIFIED", "description": "When in the step lifecycle to capture a channel value.\n\n - CAPTURE_MOMENT_UNSPECIFIED: Required zero-value enum sentinel. Do not include this in capture_moments.", "example": "CAPTURE_MOMENT_STEP_START" }, "ChannelCaptureConfig": { "type": "object", "properties": { "outputFieldId": { "type": "string", "description": "Base field ID used to namespace event property keys (and downstream procedure outputs)." }, "captureMoments": { "type": "array", "items": { "$ref": "#/definitions/CaptureMoment" }, "description": "When to capture relative to the step lifecycle. Empty means no capture occurs — at least one moment must be specified.", "uniqueItems": true, "x-constraints": [ "No duplicates." ] } }, "description": "Shared configuration for capturing a single channel value where the source channel is supplied by the parent config.\n\nAt execution time, the backend reads the channel's value at the configured moment(s) and writes it into event metadata under dotted keys derived from output_field_id." }, "ChannelLocator": { "type": "object", "properties": { "dataSourceRef": { "type": "string", "title": "Symbolic name for the data source (e.g., \"main\", \"test_data\"). This name is resolved to a concrete DataSourceRid at execution time by looking up the name in the data scopes (for assets) or data sources (for runs) specified by asset_or_run. This is NOT a field reference - it's a literal string that must match a data source ref name.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "channelName": { "type": "string", "title": "The name of the channel within the data source to validate.", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Optional series tags to filter the channel data. Used to select specific series when multiple series exist for the same channel name." }, "asset": { "$ref": "#/definitions/AssetReference" }, "run": { "$ref": "#/definitions/RunReference" } }, "description": "Locates a specific channel within a data source for validation. Uses symbolic reference names that are resolved to concrete resources at execution time, allowing procedure templates to be defined before the actual data sources exist.\n\nSet exactly one of `asset`, `run`.", "x-oneofs": [ { "fields": [ "asset", "run" ], "required": true } ], "example": { "dataSourceRef": "string", "channelName": "string", "tags": { "key": "string" }, "asset": { "rid": "string" } } }, "ChannelValidationSuccessCondition": { "type": "object", "properties": { "channel": { "$ref": "#/definitions/ChannelLocator", "description": "The channel to validate against the threshold. If the data_source_ref or channel_name cannot be resolved at execution time, the step will transition to ERRORED state immediately." }, "comparator": { "$ref": "#/definitions/COMPARATOR", "description": "The comparison operator to use. COMPARATOR_UNSPECIFIED should never be used and will be rejected at runtime." }, "threshold": { "type": "number", "format": "double", "description": "The threshold value to compare the channel data against. The comparison is: channel_value COMPARATOR threshold Using double for better precision. Note: When using COMPARATOR_EQUAL or COMPARATOR_NOT_EQUAL with floating-point channel data, be aware of potential precision issues inherent to IEEE 754. Ignored when comparator is COMPARATOR_EXISTS." }, "timeoutMillis": { "type": "integer", "format": "int32", "description": "Maximum time in milliseconds to wait for the condition to be satisfied. If the timeout expires before the comparison evaluates to true, the step moves to ERRORED. Must be greater than zero and at most one hour (3,600,000 milliseconds).", "minimum": 0, "exclusiveMinimum": true, "maximum": 3600000, "x-constraints": [ "Greater than 0 and at most 3,600,000." ] }, "pointPersistence": { "type": "integer", "format": "int64", "title": "optionally specify a persistence of individual points", "minimum": 0, "exclusiveMinimum": true, "x-constraints": [ "Greater than 0." ] }, "timePersistence": { "type": "integer", "format": "int64", "title": "optionally specify a persistence duration in milliseconds (max 5 minutes) for which the condition must hold true", "minimum": 0, "exclusiveMinimum": true, "maximum": 300000, "x-constraints": [ "Greater than 0 and at most 300,000." ] }, "channelCaptures": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/ChannelCaptureConfig" }, "description": "Channel values to capture while evaluating this success condition. These captures use the condition's channel field as their source. Each config produces dot-namespaced event-metadata properties keyed by output_field_id." } }, "description": "Defines a success condition that compares channel data against a threshold value. The step succeeds when the comparison (channel_value COMPARATOR threshold) evaluates to true within the timeout period. For example, checking if a channel value is greater than 100. Use COMPARATOR_EXISTS for capture-only conditions that succeed as soon as any channel value is observed.", "required": [ "channel", "comparator" ] }, "COMPARATOR": { "type": "string", "enum": [ "COMPARATOR_UNSPECIFIED", "COMPARATOR_GREATER_THAN", "COMPARATOR_GREATER_THAN_OR_EQUAL", "COMPARATOR_LESS_THAN", "COMPARATOR_LESS_THAN_OR_EQUAL", "COMPARATOR_EQUAL", "COMPARATOR_NOT_EQUAL", "COMPARATOR_EXISTS" ], "default": "COMPARATOR_UNSPECIFIED", "description": "Evaluation semantics: The most recent channel value within the timeout period is used for comparison. If the channel has no data, the condition will continuously retry until timeout_millis expires.\n\n - COMPARATOR_UNSPECIFIED: Unspecified comparator. This is an invalid state and should never be used. Required by proto3 convention as the zero value. Will be rejected at runtime.\n - COMPARATOR_EXISTS: Succeeds when any channel value exists. The threshold field is ignored.", "title": "Comparison operator to evaluate channel value against threshold. The condition is satisfied when: channel_value COMPARATOR threshold Example: COMPARATOR_GREATER_THAN with threshold 100.0 means channel_value > 100.0", "example": "COMPARATOR_GREATER_THAN" }, "IngestJobSuccessCondition": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "The field ID that contains the IngestJobRid of the ingest job to monitor." } }, "description": "The step will succeed when the associated ingest job succeeds. If the ingest job fails, the step will move to ERRORED." }, "NodeList": { "type": "object", "properties": { "nodeIds": { "type": "array", "items": { "type": "string" } } }, "description": "A list of node IDs." }, "ProcedureDisplayGraph": { "type": "object", "properties": { "topLevelNodes": { "type": "array", "items": { "type": "string" }, "description": "Sections or steps that do not belong to any parent sections. This is ordered in a topological ordering of steps." }, "sectionToSortedChildren": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NodeList" }, "title": "Map of section node IDs to their topologically sorted children" } }, "description": "A simpler representation of the procedure graph that is used for display in a UI." }, "RunReference": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "The field id that will contain a RunRid value. The execution will fail if the field is not set properly." } }, "title": "A reference to a single run", "x-oneofs": [ { "fields": [ "fieldId" ], "required": true } ], "example": { "fieldId": "string" } }, "TimerSuccessCondition": { "type": "object", "properties": { "durationSeconds": { "type": "integer", "format": "int32", "description": "Duration in seconds to wait before succeeding the step. This value must be non-negative. This duration is a minimum bound; the actual duration may be longer.", "minimum": 0, "x-constraints": [ "At least 0." ] } }, "description": "A timer condition that will succeed the step after a specified duration." }, "WebhookDeliveryConfig": { "type": "object", "properties": { "maxRetries": { "type": "integer", "format": "int32", "title": "Maximum delivery attempts (default: 3, max: 10)", "minimum": 0, "maximum": 10, "x-constraints": [ "From 0 to 10." ] }, "retryIntervalSeconds": { "type": "string", "format": "int64", "title": "Initial retry interval seconds (default: 15, min: 5, max: 300)", "minimum": 5, "maximum": 300, "x-constraints": [ "From 5 to 300." ] }, "exponentialBackoff": { "type": "boolean", "title": "Use exponential backoff (default: true)" }, "maxRetryIntervalSeconds": { "type": "string", "format": "int64", "title": "Max retry interval seconds (default: 300, max: 3600)", "minimum": 5, "maximum": 3600, "x-constraints": [ "From 5 to 3,600." ] }, "timeoutSeconds": { "type": "string", "format": "int64", "title": "Overall timeout seconds (default: 600, max: 86400)", "minimum": 1, "maximum": 86400, "x-constraints": [ "From 1 to 86,400." ] } }, "description": "Configuration for webhook delivery retry logic and timeouts." }, "WebhookSuccessCondition": { "type": "object", "properties": { "integrationRid": { "type": "string", "title": "RID reference to a WebhookIntegration (the advanced integration type with HMAC signing)", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "deliveryConfig": { "$ref": "#/definitions/WebhookDeliveryConfig", "description": "Webhook delivery configuration. If not provided, server uses documented defaults." }, "eventType": { "type": "string", "title": "Event type to send (e.g., \"procedure.step_waiting\")", "minLength": 1, "x-constraints": [ "At least 1 character." ] }, "payloadTemplate": { "type": "string", "description": "Advanced features:\n- Conditionals: {{#if environment}}production mode{{/if}}\n- Loops: {{#each tags}}{{this}}{{/each}}\n- Comparisons: {{#if (eq priority \"HIGH\")}}urgent{{/if}}\n- Default values: {{default environment \"unknown\"}}\n\nExample template: { \"event\": \"approval_required\", \"execution_id\": \"{{execution_rid}}\", \"step\": \"{{step_name}}\", \"environment\": \"{{environment}}\", {{#if asset_name}} \"asset\": \"{{asset_name}}\", {{/if}} \"is_production\": {{#if (eq environment \"production\")}}true{{else}}false{{/if}} }\n\nVariables that cannot be resolved will be replaced with empty string. Invalid JSON after template evaluation will cause the condition to fail with PAYLOAD_ERROR reason.", "title": "JSON payload template using Handlebars syntax (https://handlebarsjs.com/) Supports variable references using {{variable_name}} syntax:\n- {{execution_rid}} - Procedure execution RID\n- {{step_id}} - Current step ID\n- {{step_name}} - Current step name/title\n- {{procedure_name}} - Procedure name\n- {{field_id}} - Any global form field value (e.g., {{environment}}, {{approval_level}})\n- {{asset_rid}} - Asset RID if step has asset context\n- {{asset_name}} - Asset name if step has asset context", "minLength": 1, "x-constraints": [ "At least 1 character." ] } }, "description": "A webhook success condition that waits for external system approval via HTTP webhook. The step succeeds when the external system responds with 2xx status code.\n\nFailure behavior:\n- 4xx responses: Permanent failure, no retry (CLIENT_ERROR)\n- 5xx responses: Retry with exponential backoff until max_retries (SERVER_ERROR_MAX_RETRIES_EXCEEDED)\n- Network errors: Retry until max_retries (NETWORK_ERROR_MAX_RETRIES_EXCEEDED)\n- Timeout: Retry until timeout_seconds exceeded (OVERALL_TIMEOUT_EXCEEDED)\n- Redirects: Followed automatically, fails if redirect loop detected (REDIRECT_LOOP)" }, "LabelUpdateWrapper": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } }, "title": "Wrapper classes to allow for optional fields on update requests" }, "PropertyUpdateWrapper": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "securityDefinitions": { "ApiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Your API key as a bearer token: `Authorization: Bearer <api key>`." } }, "security": [ { "ApiKey": [] } ] }