{ "swagger": "2.0", "info": { "title": "Run service", "version": "0.1507.0", "description": "Send your API key as a bearer token: `Authorization: Bearer `." }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "ApiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Your API key as a bearer token: `Authorization: Bearer `." } }, "security": [ { "ApiKey": [] } ], "paths": { "/scout/v1/run": { "post": { "operationId": "RunService_createRun", "summary": "Create run", "tags": [ "Run Service" ], "description": "Create a new run in Nominal.\n\nThrows if start is equal to or after end.", "parameters": [ { "name": "details", "in": "body", "schema": { "$ref": "#/definitions/CreateRunRequest" }, "required": true, "x-example": { "title": "", "description": "<description>", "startTime": { "secondsSinceEpoch": 1 } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/Run" }, "x-example": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } }, "/scout/v1/run/{rid}": { "put": { "operationId": "RunService_updateRun", "summary": "Update run", "tags": [ "Run Service" ], "description": "Updates an existing run based on its RID.\n\nThrows if start is equal to or after end.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true }, { "name": "details", "in": "body", "schema": { "$ref": "#/definitions/UpdateRunRequest" }, "required": true, "x-example": { "title": "<title>", "description": "<description>", "startTime": { "secondsSinceEpoch": 1 }, "endTime": { "secondsSinceEpoch": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "url": "<url>" } ], "runPrefix": "<run prefix>", "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "dataSourceRid": "<data source rid>", "offset": { "seconds": 1, "nanos": 1 }, "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "strictOverwrite": true } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/Run" }, "x-example": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } }, "get": { "operationId": "RunService_getRun", "summary": "Get run", "tags": [ "Run Service" ], "description": "Fetches details about the run in question based on its RID.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/Run" }, "x-example": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } }, "/scout/v1/run/metadata/batch-edit": { "post": { "operationId": "RunService_batchEditRunMetadata", "summary": "Batch edit run metadata", "tags": [ "Run Service" ], "description": "Batch edits metadata across multiple runs. Supports rename/merge for labels and properties. If more than 1000 runs are targeted, this endpoint will throw a 400.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchEditRunMetadataRequest" }, "required": true, "x-example": { "operation": { "type": "renameLabel", "renameLabel": { "target": "<label>" } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchEditRunMetadataResponse" }, "x-example": { "modifiedRunRids": [ "<run rid>" ], "conflictingRunRids": [ "<run rid>" ] } } } } }, "/scout/v1/run/{runRid}/data-sources": { "post": { "operationId": "RunService_addDataSourcesToRun", "summary": "Add data sources to run", "tags": [ "Run Service" ], "description": "Adds datasources to the run in question.\n\nThrows if any of the ref names conflict with existing data sources or each other.", "parameters": [ { "name": "runRid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true }, { "name": "request", "in": "body", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CreateRunDataSource" }, "x-map-key": "DataSourceRefName", "example": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "dataSourceRid": "<data source rid>", "offset": { "seconds": 1, "nanos": 1 }, "seriesTags": { "<key>": "<tag value>" } } } }, "required": false, "x-example": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "dataSourceRid": "<data source rid>", "offset": { "seconds": 1, "nanos": 1 }, "seriesTags": { "<key>": "<tag value>" } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/Run" }, "x-example": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } }, "/scout/v1/run/create-or-update": { "post": { "operationId": "RunService_createOrUpdateRun", "summary": "Create or update run", "tags": [ "Run Service" ], "description": "Updates a run if it exists, otherwise it's created from scratch. Will throw if the workspace of an existing run is different from the workspace of the request.", "parameters": [ { "name": "details", "in": "body", "schema": { "$ref": "#/definitions/CreateOrUpdateRunRequest" }, "required": true, "x-example": { "createRunRequest": { "title": "<title>", "description": "<description>", "startTime": { "secondsSinceEpoch": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/Run" }, "x-example": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } }, "/scout/v1/run/{rid}/with-data-review-metrics": { "get": { "operationId": "RunService_getRunWithDataReviewMetrics", "summary": "Get run with data review metrics", "tags": [ "Run Service" ], "description": "Fetches details about the run in question based on its RID, including metrics for check and violation review status.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/RunWithDataReviewMetrics" }, "x-example": { "run": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" }, "dataReviewMetrics": { "checks": { "pendingExecution": 1, "executing": 1, "passingAutomatic": 1, "pendingReview": 1, "closedWithIgnore": 1, "closedWithFurtherAction": 1, "failedToExecutePendingReview": 1, "failedToExecuteClosedWithIgnore": 1, "failedToExecuteClosedWithFurtherAction": 1 }, "alerts": { "pendingReview": 1, "closedWithIgnore": 1, "closedWithFurtherAction": 1 } } } } } } }, "/scout/v1/run/{rid}/with-data-review-summary": { "get": { "operationId": "RunService_getRunWithDataReviewSummary", "summary": "Get run with data review summary", "tags": [ "Run Service" ], "description": "Fetches details about the run in question based on its RID, including a summary of the data review status.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/RunWithDataReviewSummary" }, "x-example": { "run": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" }, "dataReviewSummary": { "evaluationStatus": "NO_CHECKS_APPLIED", "totalIssueCount": 1, "reviewedIssueCount": 1, "issuesWithFurtherActionCount": 1, "executionErrorCount": 1 } } } } } }, "/scout/v1/run/by-id": { "post": { "operationId": "RunService_getRunById", "summary": "Get run by ID", "tags": [ "Run Service" ], "description": "Fetches a run based on the run number, rather than RID.", "parameters": [ { "name": "getRunByIdRequest", "in": "body", "schema": { "$ref": "#/definitions/GetRunByIdRequest" }, "required": true, "x-example": { "runNumber": 1 } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/Run" }, "x-example": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } }, "/scout/v1/run/multiple": { "post": { "operationId": "RunService_getRuns", "summary": "Get runs", "tags": [ "Run Service" ], "description": "Fetches a list of run details based on a list of RIDs.", "parameters": [ { "name": "rids", "in": "body", "schema": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "uniqueItems": true, "example": [ "<run rid>" ] }, "required": false, "x-example": [ "<run rid>" ] } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Run" }, "x-map-key": "RunRid" }, "x-example": { "<key>": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } } }, "/scout/v1/run/by-asset": { "post": { "operationId": "RunService_getRunsByAsset", "summary": "Get runs by asset", "tags": [ "Run Service" ], "description": "Fetches the runs with the given asset.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/GetRunsByAssetRequest" }, "required": true, "x-example": { "asset": "<asset rid>" } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRunsByAssetResponse" }, "x-example": { "results": [ { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } ], "nextPageToken": "<next page token>" } } } } }, "/scout/v1/run/by-assets/latest": { "post": { "operationId": "RunService_getLatestRunForAssets", "summary": "Get latest run for assets", "tags": [ "Run Service" ], "description": "Fetches the latest run for each requested asset. Assets without associated runs will not be included in response.", "parameters": [ { "name": "request", "in": "body", "schema": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "uniqueItems": true, "example": [ "<asset rid>" ] }, "required": false, "x-example": [ "<asset rid>" ] } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Run" }, "x-map-key": "AssetRid" }, "x-example": { "<key>": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } } } } } }, "/scout/v1/all-runs-properties-labels": { "get": { "operationId": "RunService_getAllRunsPropertiesAndLabels", "summary": "Get all runs properties and labels", "tags": [ "Run Service" ], "description": "This legacy bulk-list surface returns string property values only.", "deprecated": true, "x-deprecated": "Deprecated in favor of MetadataService#listPropertiesAndLabels", "parameters": [ { "name": "workspaces", "in": "query", "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "collectionFormat": "multi", "required": false, "description": "If supplied, will return only the properties and labels that are associated with the supplied workspaces. If empty will return all properties and labels for workspaces that the user is permitted to see." } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/AllRunsPropertiesAndLabelsResponse" }, "x-example": { "properties": { "<key>": [ "<property value>" ] }, "labels": [ "<label>" ] } } } } }, "/scout/v1/search-runs": { "post": { "operationId": "RunService_searchRuns", "summary": "Search runs", "tags": [ "Run Service" ], "description": "Searches for runs that match the given filters. Defaults to returning un-archived runs, absent an archive filter.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/SearchRunsRequest" }, "required": true, "x-example": { "sort": { "isDescending": true }, "pageSize": 1, "query": { "type": "startTimeInclusive", "startTimeInclusive": { "secondsSinceEpoch": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchRunsResponse" }, "x-example": { "results": [ { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" } ], "nextPageToken": "<token>", "totalCount": 1 } } } } }, "/scout/v1/search-runs-with-data-review-metrics": { "post": { "operationId": "RunService_searchRunsWithDataReviewMetrics", "summary": "Search runs with data review metrics", "tags": [ "Run Service" ], "description": "Searches for runs that match the given filters and includes metrics for check and violation review status. Defaults to returning un-archived runs, absent an archive filter.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/SearchRunsRequest" }, "required": true, "x-example": { "sort": { "isDescending": true }, "pageSize": 1, "query": { "type": "startTimeInclusive", "startTimeInclusive": { "secondsSinceEpoch": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchRunsWithDataReviewMetricsResponse" }, "x-example": { "results": [ { "run": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" }, "dataReviewMetrics": { "checks": { "pendingExecution": 1, "executing": 1, "passingAutomatic": 1, "pendingReview": 1, "closedWithIgnore": 1, "closedWithFurtherAction": 1, "failedToExecutePendingReview": 1, "failedToExecuteClosedWithIgnore": 1, "failedToExecuteClosedWithFurtherAction": 1 }, "alerts": { "pendingReview": 1, "closedWithIgnore": 1, "closedWithFurtherAction": 1 } } } ], "nextPageToken": "<token>" } } } } }, "/scout/v1/search-runs-with-data-review-summary": { "post": { "operationId": "RunService_searchRunsWithDataReviewSummary", "summary": "Search runs with data review summary", "tags": [ "Run Service" ], "description": "Searches for runs that match the given filters and includes a summary of the data review status. Defaults to returning un-archived runs, absent an archive filter.", "deprecated": true, "x-deprecated": "Deprecated in favor of searchRunsWithDataReviewMetrics", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/SearchRunsRequest" }, "required": true, "x-example": { "sort": { "isDescending": true }, "pageSize": 1, "query": { "type": "startTimeInclusive", "startTimeInclusive": { "secondsSinceEpoch": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchRunsWithDataReviewSummaryResponse" }, "x-example": { "results": [ { "run": { "rid": "<run rid>", "runNumber": 1, "runPrefix": "<run prefix>", "title": "<title>", "description": "<description>", "authorRid": "<user rid>", "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "title": "<title>", "url": "<url>" } ], "createdAt": "2026-01-01T00:00:00Z", "updatedAt": "2026-01-01T00:00:00Z", "assetDataScopesMap": { "<key>": { "dataScopes": { "<key>": { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } } } }, "assetDataScopes": [ { "dataScopeName": "<data source ref name>", "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } ], "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "offset": { "seconds": 1, "nanos": 1 }, "refName": "<data source ref name>", "timestampType": "ABSOLUTE", "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "isArchived": true, "lockStatus": "LOCKED" }, "dataReviewSummary": { "evaluationStatus": "NO_CHECKS_APPLIED", "totalIssueCount": 1, "reviewedIssueCount": 1, "issuesWithFurtherActionCount": 1, "executionErrorCount": 1 } } ], "nextPageToken": "<token>" } } } } }, "/scout/v1/archive-run/{rid}": { "put": { "operationId": "RunService_archiveRun", "summary": "Archive run", "tags": [ "Run Service" ], "description": "Soft-deletes a run. Runs still exist in the database but are no longer visible.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true }, { "name": "includeLinkedWorkbooks", "in": "query", "type": "boolean", "required": false, "description": "If true, all workbooks that are linked to the run will be archived as well. Defaults to false." } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "boolean" }, "x-example": true } } } }, "/scout/v1/unarchive-run/{rid}": { "put": { "operationId": "RunService_unarchiveRun", "summary": "Unarchive run", "tags": [ "Run Service" ], "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true }, { "name": "includeLinkedWorkbooks", "in": "query", "type": "boolean", "required": false, "description": "If true, all auto-archived workbooks that are linked to run will be unarchived as well. Defaults to false." } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "boolean" }, "x-example": true } } } }, "/scout/v1/archive-run": { "post": { "operationId": "RunService_archiveRuns", "summary": "Archive runs", "tags": [ "Run Service" ], "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/ArchiveRunsRequest" }, "required": true, "x-example": { "rids": [ "<run rid>" ], "includeLinkedWorkbooks": true } } ], "responses": { "204": { "description": "No content." } } } }, "/scout/v1/unarchive-run": { "post": { "operationId": "RunService_unarchiveRuns", "summary": "Unarchive runs", "tags": [ "Run Service" ], "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/UnarchiveRunsRequest" }, "required": true, "x-example": { "rids": [ "<run rid>" ], "includeLinkedWorkbooks": true } } ], "responses": { "204": { "description": "No content." } } } }, "/scout/v1/data-source-ref-names-and-types": { "get": { "operationId": "RunService_getDataSourceRefNameAndTypeList", "summary": "Get data source ref name and type list", "tags": [ "Run Service" ], "description": "Returns the list of ref names that are in use across specified and authorized workspaces.", "parameters": [ { "name": "workspaces", "in": "query", "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "collectionFormat": "multi", "required": false, "description": "If not empty, will return only the ref names that are associated with the supplied workspaces. If empty will return all ref names for workspaces that the user is permitted to see." } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "array", "items": { "$ref": "#/definitions/RefNameAndType" } }, "x-example": [ { "name": "<data source ref name>", "type": "DATASET" } ] } } } }, "/scout/v1/run/{rid}/attachments": { "post": { "operationId": "RunService_updateRunAttachment", "summary": "Update run attachment", "tags": [ "Run Service" ], "description": "Updates the attachments associated with a run.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "RunRid", "required": true }, { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/UpdateAttachmentsRequest" }, "required": true, "x-example": { "attachmentsToAdd": [ "<attachment rid>" ], "attachmentsToRemove": [ "<attachment rid>" ] } } ], "responses": { "204": { "description": "No content." } } } } }, "definitions": { "ArchivedStatus": { "type": "string", "enum": [ "NOT_ARCHIVED", "ARCHIVED" ] }, "NumericPropertyPredicate": { "description": "Matches resources that have a numeric value for the named property and whose value satisfies the operator. NEQ excludes resources that lack the property or store a string value under the same name.", "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "value": { "type": "number", "format": "double" }, "operator": { "$ref": "#/definitions/PropertyComparisonOperator" } }, "required": [ "name", "value", "operator" ] }, "NumericPropertyRangeOperator": { "type": "string", "enum": [ "BETWEEN", "NOT_BETWEEN" ] }, "NumericPropertyRangePredicate": { "description": "Inclusive range on a numeric property. At least one bound is required. BETWEEN: min <= x <= max. An absent bound is unbounded on that side. NOT_BETWEEN: x < min OR x > max. An absent bound drops that side. Both operators require a numeric value for `name`. Missing properties and string values never match. Bounds are closed [min, max] to match the number chip (is between / is not between), not half-open.", "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" }, "operator": { "$ref": "#/definitions/NumericPropertyRangeOperator" } }, "required": [ "name", "operator" ] }, "Property": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "value": { "type": "string", "x-alias": "PropertyValue" } }, "required": [ "name", "value" ] }, "PropertyComparisonOperator": { "type": "string", "enum": [ "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "SetOperator": { "type": "string", "enum": [ "AND", "OR" ] }, "TypedPropertyValue": { "description": "Typed metadata value. Additional variants may be added as property types expand.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "stringValue", "numericValue" ] }, "stringValue": { "type": "string", "x-alias": "PropertyValue" }, "numericValue": { "type": "number", "format": "double" } }, "required": [ "type" ], "example": { "type": "stringValue", "stringValue": "string" } }, "DataScope": { "type": "object", "properties": { "dataScopeName": { "type": "string", "x-alias": "DataSourceRefName", "description": "The name of the data scope. The name is guaranteed to be be unique within the context of an asset." }, "dataSource": { "$ref": "#/definitions/DataSource" }, "offset": { "$ref": "#/definitions/Duration" }, "timestampType": { "$ref": "#/definitions/WeakTimestampType" }, "seriesTags": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "TagValue" }, "x-map-key": "TagName", "description": "Filters the data source to series matching these tag values. The filtered set of series should be the ones that belong to the asset." } }, "required": [ "dataScopeName", "dataSource", "timestampType" ] }, "Operator": { "type": "string", "enum": [ "LEQ", "LT", "GEQ", "GT", "EQ" ] }, "ConflictBehavior": { "description": "Controls what happens when a rename target property key already exists on a document.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "skip", "overwrite" ] }, "skip": { "$ref": "#/definitions/SkipOnConflict" }, "overwrite": { "$ref": "#/definitions/OverwriteOnConflict" } }, "required": [ "type" ], "example": { "type": "skip", "skip": {} } }, "MergePropertyValuesForKey": { "description": "Merge one or more string values of a property key into a single target value. Merge applies to categorical aliases; continuous numeric values are intentionally excluded.", "type": "object", "properties": { "key": { "type": "string", "x-alias": "PropertyName" }, "source": { "type": "array", "items": { "type": "string", "x-alias": "PropertyValue" }, "uniqueItems": true }, "target": { "type": "string", "x-alias": "PropertyValue" } }, "required": [ "key", "target" ] }, "MetadataChange": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "renameLabel", "renamePropertyKey", "mergePropertyValuesForKey" ] }, "renameLabel": { "$ref": "#/definitions/RenameLabel" }, "renamePropertyKey": { "$ref": "#/definitions/RenamePropertyKey" }, "mergePropertyValuesForKey": { "$ref": "#/definitions/MergePropertyValuesForKey" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "renameLabel", "renameLabel": { "source": [ "string" ], "target": "string" } } }, "OverwriteOnConflict": { "description": "Documents that already have the target property key are included in the rename. The priority list determines which value wins via ordered precedence. Must contain exactly the source keys + target key.", "type": "object", "properties": { "priority": { "type": "array", "items": { "type": "string", "x-alias": "PropertyName" } } } }, "RenameLabel": { "description": "Rename or merge one or more source labels into a single target label.", "type": "object", "properties": { "source": { "type": "array", "items": { "type": "string", "x-alias": "Label" }, "uniqueItems": true }, "target": { "type": "string", "x-alias": "Label" } }, "required": [ "target" ] }, "RenamePropertyKey": { "description": "Rename one or more source property keys to a single target key. Existing values are preserved under the new key. The rename should be skipped in the service for resources w/ conflicting keys.", "type": "object", "properties": { "source": { "type": "array", "items": { "type": "string", "x-alias": "PropertyName" }, "uniqueItems": true }, "target": { "type": "string", "x-alias": "PropertyName" }, "onConflict": { "$ref": "#/definitions/ConflictBehavior" } }, "required": [ "target", "onConflict" ] }, "SkipOnConflict": { "description": "Documents are skipped when:\n- The target property key already exists on the document, or\n- Multiple source property keys exist on the document (ambiguous merge). Conflicting document RIDs are returned in the response.", "type": "object", "properties": {} }, "CheckAlertState": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pendingReview", "closedWithFurtherAction", "closedWithIgnore" ] }, "pendingReview": { "$ref": "#/definitions/PendingReviewAlertState" }, "closedWithFurtherAction": { "$ref": "#/definitions/ClosedWithFurtherActionAlertState" }, "closedWithIgnore": { "$ref": "#/definitions/ClosedWithIgnoreAlertState" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pendingReview", "pendingReview": {} } }, "ClosedWithFurtherActionAlertState": { "type": "object", "properties": { "comment": { "type": "string" }, "closedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "required": [ "comment", "closedBy" ] }, "ClosedWithIgnoreAlertState": { "type": "object", "properties": { "comment": { "type": "string" }, "closedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "required": [ "comment", "closedBy" ] }, "LabelsFilter": { "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "labels": { "type": "array", "items": { "type": "string", "x-alias": "Label" } } }, "required": [ "operator" ] }, "PendingReviewAlertState": { "type": "object", "properties": {} }, "PropertiesFilter": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "values": { "type": "array", "items": { "type": "string", "x-alias": "PropertyValue" } } }, "required": [ "name" ] }, "AllRunsPropertiesAndLabelsResponse": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "x-alias": "PropertyValue" }, "uniqueItems": true }, "x-map-key": "PropertyName" }, "labels": { "type": "array", "items": { "type": "string", "x-alias": "Label" }, "uniqueItems": true } } }, "ArchiveRunsRequest": { "type": "object", "properties": { "rids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "uniqueItems": true }, "includeLinkedWorkbooks": { "type": "boolean", "description": "If true, all auto-archived workbooks that are linked to run will be unarchived as well. Defaults to false." } }, "example": { "rids": [ "<run rid>" ], "includeLinkedWorkbooks": true } }, "AssetsFilter": { "description": "returns runs that match any of the provided assets.", "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } } } }, "BatchEditRunMetadataRequest": { "type": "object", "properties": { "runSearchQuery": { "allOf": [ { "$ref": "#/definitions/SearchQuery" } ], "description": "Additional search query to filter which runs are targeted by the edit. Source labels/properties from the metadata change are automatically included as filters." }, "operation": { "$ref": "#/definitions/MetadataChange" } }, "required": [ "operation" ], "example": { "operation": { "type": "renameLabel", "renameLabel": { "target": "<label>" } } } }, "BatchEditRunMetadataResponse": { "type": "object", "properties": { "modifiedRunRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "description": "RIDs for runs that were modified by the batch edit." }, "conflictingRunRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "description": "RIDs for runs that matched the source filter but already had the target property key and were skipped (SkipOnConflict behavior). Empty for operations without conflict semantics or when using OverwriteOnConflict." } } }, "CheckAlertStatesFilter": { "type": "object", "properties": { "checkAlertState": { "$ref": "#/definitions/CheckAlertState" }, "operator": { "$ref": "#/definitions/Operator" }, "threshold": { "type": "integer", "format": "int64" } }, "required": [ "checkAlertState", "operator", "threshold" ] }, "CreateOrUpdateRunRequest": { "type": "object", "properties": { "runRid": { "type": "string", "format": "rid", "x-alias": "RunRid", "description": "If a run with the same rid already exists, it will be updated. Otherwise, a new run will be created." }, "createRunRequest": { "$ref": "#/definitions/CreateRunRequest" } }, "required": [ "createRunRequest" ], "example": { "createRunRequest": { "title": "<title>", "description": "<description>", "startTime": { "secondsSinceEpoch": 1 } } } }, "CreateRunDataSource": { "description": "For write requests, we want to allow for optional fields", "type": "object", "properties": { "dataSource": { "allOf": [ { "$ref": "#/definitions/DataSource" } ], "description": "One of dataSource and dataSourceRid must be present. dataSourceRid takes precedence.", "x-deprecated": "Use dataSourceRid instead." }, "dataSourceRid": { "type": "string", "format": "rid", "x-alias": "DataSourceRid", "description": "One of dataSource and dataSourceRid must be present. dataSourceRid takes precedence." }, "offset": { "$ref": "#/definitions/Duration" }, "seriesTags": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "TagValue" }, "x-map-key": "TagName", "description": "Used to resolve logical series for this data source." } } }, "CreateRunRequest": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "startTime": { "$ref": "#/definitions/UtcTimestamp" }, "endTime": { "$ref": "#/definitions/UtcTimestamp" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "PropertyValue" }, "x-map-key": "PropertyName", "x-deprecated": "use typedProperties" }, "typedProperties": { "type": "object", "additionalProperties": { "$ref": "#/definitions/TypedPropertyValue" }, "x-map-key": "PropertyName" }, "labels": { "type": "array", "items": { "type": "string", "x-alias": "Label" }, "uniqueItems": true }, "links": { "type": "array", "items": { "$ref": "#/definitions/Link" } }, "runPrefix": { "type": "string" }, "dataSources": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CreateRunDataSource" }, "x-map-key": "DataSourceRefName" }, "attachments": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AttachmentRid" }, "uniqueItems": true }, "asset": { "type": "string", "format": "rid", "x-alias": "AssetRid", "x-deprecated": "Use assets" }, "assets": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid", "description": "The workspace in which to create the run. If not provided, the run will be created in the default workspace for the user's organization, if the default workspace for the organization is configured. All data sources, attachments, and assets must be in the same workspace." } }, "required": [ "title", "description", "startTime" ], "example": { "title": "<title>", "description": "<description>", "startTime": { "secondsSinceEpoch": 1 } } }, "CustomTimeframeFilter": { "type": "object", "properties": { "startTime": { "$ref": "#/definitions/UtcTimestamp" }, "endTime": { "$ref": "#/definitions/UtcTimestamp" } } }, "DataReviewAlertMetrics": { "type": "object", "properties": { "pendingReview": { "type": "integer", "format": "int32" }, "closedWithIgnore": { "type": "integer", "format": "int32" }, "closedWithFurtherAction": { "type": "integer", "format": "int32" } }, "required": [ "pendingReview", "closedWithIgnore", "closedWithFurtherAction" ] }, "DataReviewCheckMetrics": { "type": "object", "properties": { "pendingExecution": { "type": "integer", "format": "int32" }, "executing": { "type": "integer", "format": "int32" }, "passingAutomatic": { "type": "integer", "format": "int32" }, "pendingReview": { "type": "integer", "format": "int32" }, "closedWithIgnore": { "type": "integer", "format": "int32" }, "closedWithFurtherAction": { "type": "integer", "format": "int32" }, "failedToExecutePendingReview": { "type": "integer", "format": "int32" }, "failedToExecuteClosedWithIgnore": { "type": "integer", "format": "int32" }, "failedToExecuteClosedWithFurtherAction": { "type": "integer", "format": "int32" } }, "required": [ "pendingExecution", "executing", "passingAutomatic", "pendingReview", "closedWithIgnore", "closedWithFurtherAction", "failedToExecutePendingReview", "failedToExecuteClosedWithIgnore", "failedToExecuteClosedWithFurtherAction" ] }, "DataReviewMetrics": { "type": "object", "properties": { "checks": { "$ref": "#/definitions/DataReviewCheckMetrics" }, "alerts": { "$ref": "#/definitions/DataReviewAlertMetrics" } }, "required": [ "checks", "alerts" ] }, "DataScopes": { "type": "object", "properties": { "dataScopes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DataScope" }, "x-map-key": "DataSourceRefName" } } }, "DataSource": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "dataset", "connection", "logSet", "video", "spatial" ] }, "dataset": { "type": "string", "format": "rid", "x-alias": "DatasetRid" }, "connection": { "type": "string", "format": "rid", "x-alias": "ConnectionRid" }, "logSet": { "type": "string", "format": "rid", "x-alias": "LogSetRid" }, "video": { "type": "string", "format": "rid", "x-alias": "VideoRid" }, "spatial": { "type": "string", "format": "rid", "x-alias": "SpatialRid" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "dataset", "dataset": "string" } }, "DataSourceSeriesTag": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "TagName" }, "value": { "type": "string", "x-alias": "TagValue" } }, "required": [ "name", "value" ] }, "DataSourceType": { "type": "string", "enum": [ "DATASET", "CONNECTION", "LOGSET", "VIDEO", "SPATIAL" ] }, "Duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "nanos": { "type": "integer", "format": "int64" } }, "required": [ "seconds", "nanos" ] }, "GetRunByIdRequest": { "type": "object", "properties": { "runNumber": { "type": "integer", "format": "int64" }, "runPrefix": { "type": "string" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid", "description": "The workspace in which to query for the run. If not provided, the run will be queried in the default workspace for the user's organization, if the default workspace for the organization is configured and the user has access to it." } }, "required": [ "runNumber" ], "example": { "runNumber": 1 } }, "GetRunsByAssetRequest": { "type": "object", "properties": { "asset": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "nextPageToken": { "type": "string", "format": "uuid" } }, "required": [ "asset" ], "example": { "asset": "<asset rid>" } }, "GetRunsByAssetResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/Run" } }, "nextPageToken": { "type": "string", "format": "uuid" } } }, "Link": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ] }, "LockStatus": { "description": "Whether the run is locked, preventing any changes from being made.", "type": "string", "enum": [ "LOCKED", "UNLOCKED" ] }, "PresetTimeframeDuration": { "type": "string", "enum": [ "ALL_TIME", "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "LAST_YEAR" ] }, "PresetTimeframeFilter": { "type": "object", "properties": { "duration": { "$ref": "#/definitions/PresetTimeframeDuration" } }, "required": [ "duration" ] }, "RefNameAndType": { "description": "Scoped to the org-level, intended to help the frontend prevent users from submitting invalid ref names, ex. using a `dataset` ref name for a `connection` data source", "type": "object", "properties": { "name": { "type": "string", "x-alias": "DataSourceRefName" }, "type": { "$ref": "#/definitions/DataSourceType" } }, "required": [ "name", "type" ] }, "Run": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "runNumber": { "type": "integer", "format": "int64" }, "runPrefix": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "authorRid": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "startTime": { "$ref": "#/definitions/UtcTimestamp" }, "endTime": { "$ref": "#/definitions/UtcTimestamp" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "PropertyValue" }, "x-map-key": "PropertyName", "x-deprecated": "use typedProperties" }, "typedProperties": { "type": "object", "additionalProperties": { "$ref": "#/definitions/TypedPropertyValue" }, "x-map-key": "PropertyName" }, "labels": { "type": "array", "items": { "type": "string", "x-alias": "Label" }, "uniqueItems": true }, "links": { "type": "array", "items": { "$ref": "#/definitions/Link" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "assetDataScopesMap": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DataScopes" }, "x-map-key": "AssetRid", "description": "Map from asset RIDs to their data scopes" }, "assetDataScopes": { "type": "array", "items": { "$ref": "#/definitions/DataScope" }, "x-deprecated": "Use assetDataScopesMap instead. Will be empty for multi-asset runs." }, "dataSources": { "type": "object", "additionalProperties": { "$ref": "#/definitions/RunDataSource" }, "x-map-key": "DataSourceRefName", "description": "Map from refnames to run data sources. Will be empty for multi-asset runs." }, "attachments": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AttachmentRid" }, "uniqueItems": true }, "asset": { "type": "string", "format": "rid", "x-alias": "AssetRid", "x-deprecated": "Use assets" }, "assets": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } }, "isArchived": { "type": "boolean" }, "lockStatus": { "allOf": [ { "$ref": "#/definitions/LockStatus" } ], "description": "When absent, defaults to UNLOCKED for back-compat." } }, "required": [ "rid", "runNumber", "title", "description", "startTime", "createdAt", "updatedAt", "isArchived" ] }, "RunDataReviewEvaluationStatus": { "type": "string", "enum": [ "NO_CHECKS_APPLIED", "FAILED_TO_EXECUTE", "EXECUTING", "PENDING_EXECUTION", "CLOSED_WITH_FURTHER_ACTION", "GENERATED_ALERTS", "CLOSED_WITH_IGNORE", "PASSING" ] }, "RunDataReviewSummary": { "type": "object", "properties": { "evaluationStatus": { "$ref": "#/definitions/RunDataReviewEvaluationStatus" }, "totalIssueCount": { "type": "integer", "format": "int32" }, "reviewedIssueCount": { "type": "integer", "format": "int32" }, "issuesWithFurtherActionCount": { "type": "integer", "format": "int32" }, "executionErrorCount": { "type": "integer", "format": "int32" } }, "required": [ "evaluationStatus", "totalIssueCount", "reviewedIssueCount", "issuesWithFurtherActionCount", "executionErrorCount" ] }, "RunDataSource": { "description": "For read requests, we want to require all fields", "type": "object", "properties": { "dataSource": { "$ref": "#/definitions/DataSource" }, "offset": { "allOf": [ { "$ref": "#/definitions/Duration" } ], "description": "This offset is used for small time-sync corrections. Notably, it is not the offset to move a relative data source to the start of the run." }, "refName": { "type": "string", "x-alias": "DataSourceRefName", "description": "Included for convenience, duplicated from the key of the map" }, "timestampType": { "$ref": "#/definitions/WeakTimestampType" }, "seriesTags": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "TagValue" }, "x-map-key": "TagName", "description": "Used to resolve logical series for this data source." } }, "required": [ "dataSource", "offset", "refName", "timestampType" ] }, "RunWithDataReviewMetrics": { "type": "object", "properties": { "run": { "$ref": "#/definitions/Run" }, "dataReviewMetrics": { "$ref": "#/definitions/DataReviewMetrics" } }, "required": [ "run", "dataReviewMetrics" ] }, "RunWithDataReviewSummary": { "type": "object", "properties": { "run": { "$ref": "#/definitions/Run" }, "dataReviewSummary": { "$ref": "#/definitions/RunDataReviewSummary" } }, "required": [ "run", "dataReviewSummary" ] }, "SearchQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "startTimeInclusive", "startTime", "endTimeInclusive", "endTime", "timeRange", "createdAt", "exactMatch", "searchText", "asset", "assets", "isSingleAsset", "label", "labels", "property", "propertyKey", "properties", "numericProperty", "numericPropertyRange", "dataSourceSeriesTag", "dataSourceRefName", "dataSource", "runNumber", "runPrefix", "checkAlertStatesFilter", "archived", "and", "or", "not", "workspace", "lockStatus", "datasetRids" ] }, "startTimeInclusive": { "allOf": [ { "$ref": "#/definitions/UtcTimestamp" } ], "x-deprecated": "Use startTime instead" }, "startTime": { "$ref": "#/definitions/TimeframeFilter" }, "endTimeInclusive": { "allOf": [ { "$ref": "#/definitions/UtcTimestamp" } ], "x-deprecated": "Use endTime instead" }, "endTime": { "$ref": "#/definitions/TimeframeFilter" }, "timeRange": { "$ref": "#/definitions/TimeRangeFilter" }, "createdAt": { "$ref": "#/definitions/TimeframeFilter" }, "exactMatch": { "type": "string", "description": "Performs case insensitive exact substring match search on the title." }, "searchText": { "type": "string" }, "asset": { "type": "string", "format": "rid", "x-alias": "AssetRid", "x-deprecated": "Use getRunsByAsset rather than text-based search" }, "assets": { "$ref": "#/definitions/AssetsFilter" }, "isSingleAsset": { "type": "boolean", "description": "Search for either only single-asset runs (true), or only multi-asset runs (false)." }, "label": { "type": "string", "x-alias": "Label", "x-deprecated": "use labels instead" }, "labels": { "$ref": "#/definitions/LabelsFilter" }, "property": { "allOf": [ { "$ref": "#/definitions/Property" } ], "x-deprecated": "use properties" }, "propertyKey": { "type": "string", "x-alias": "PropertyName", "description": "Matches runs that have a property with this key, regardless of value." }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "numericProperty": { "allOf": [ { "$ref": "#/definitions/NumericPropertyPredicate" } ], "description": "Matches runs using a numeric property comparison." }, "numericPropertyRange": { "allOf": [ { "$ref": "#/definitions/NumericPropertyRangePredicate" } ], "description": "Matches runs using an inclusive numeric property range." }, "dataSourceSeriesTag": { "$ref": "#/definitions/DataSourceSeriesTag" }, "dataSourceRefName": { "type": "string", "x-alias": "DataSourceRefName" }, "dataSource": { "allOf": [ { "$ref": "#/definitions/DataSource" } ], "x-deprecated": "Use dataSourceRefName, rather than searching directly by DataSource." }, "runNumber": { "type": "integer", "format": "int64" }, "runPrefix": { "type": "string" }, "checkAlertStatesFilter": { "allOf": [ { "$ref": "#/definitions/CheckAlertStatesFilter" } ], "description": "Search for runs where its aggregated check alert satisfy a given operator and threshold." }, "archived": { "type": "boolean" }, "and": { "type": "array", "items": { "$ref": "#/definitions/SearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/SearchQuery" } }, "not": { "$ref": "#/definitions/SearchQuery" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "lockStatus": { "$ref": "#/definitions/LockStatus" }, "datasetRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "DatasetRid" }, "uniqueItems": true, "description": "Applied as a post-filter to the page returned by unified search. A run matches when any requested dataset is in its data scopes. At most 10 dataset RIDs may be provided." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "startTimeInclusive", "startTimeInclusive": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 } } }, "SearchRunsRequest": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/SortOptions" }, "pageSize": { "type": "integer", "format": "int32", "description": "Maximum page size is 10000 for searchRuns, and 1000 for searchRunsWithDataReviewMetrics and searchRunsWithDataReviewSummary. Larger page sizes are rejected." }, "nextPageToken": { "type": "string", "x-alias": "Token" }, "query": { "$ref": "#/definitions/SearchQuery" }, "archivedStatuses": { "type": "array", "items": { "$ref": "#/definitions/ArchivedStatus" }, "uniqueItems": true, "description": "Default search status is NOT_ARCHIVED if none are provided. Allows for including archived runs in search.", "x-deprecated": "use archived filter in search query instead." }, "includeMatchCount": { "type": "boolean", "description": "When true, the response populates totalCount with the number of runs matching the query. Defaults to false. Computing the count is an additional query whose cost grows with the size of the matching set, so only set this when the count is needed." } }, "required": [ "sort", "pageSize", "query" ], "example": { "sort": { "isDescending": true }, "pageSize": 1, "query": { "type": "startTimeInclusive", "startTimeInclusive": { "secondsSinceEpoch": 1 } } } }, "SearchRunsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/Run" } }, "nextPageToken": { "type": "string", "x-alias": "Token" }, "totalCount": { "type": "integer", "format": "int32", "description": "The number of runs matching the query, workspace, and archived filters. Present only when includeMatchCount was set to true on the request." } } }, "SearchRunsWithDataReviewMetricsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/RunWithDataReviewMetrics" } }, "nextPageToken": { "type": "string", "x-alias": "Token" } } }, "SearchRunsWithDataReviewSummaryResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/RunWithDataReviewSummary" } }, "nextPageToken": { "type": "string", "x-alias": "Token" } } }, "SortField": { "type": "string", "enum": [ "NAME", "ID", "CREATED_AT", "START_TIME", "END_TIME", "PENDING_CHECK_ALERTS" ] }, "SortKey": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "field", "property", "numericProperty" ] }, "field": { "$ref": "#/definitions/SortField" }, "property": { "allOf": [ { "$ref": "#/definitions/SortProperty" } ], "description": "Sort by a property value. Requires a property name, and will always sort null values last." }, "numericProperty": { "allOf": [ { "$ref": "#/definitions/SortProperty" } ], "description": "Sort by a numeric property value. String-valued and missing properties are null and always sort last." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "field", "field": "NAME" } }, "SortKeyWithDirection": { "type": "object", "properties": { "sortKey": { "$ref": "#/definitions/SortKey" }, "isDescending": { "type": "boolean" } }, "required": [ "sortKey", "isDescending" ] }, "SortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "allOf": [ { "$ref": "#/definitions/SortField" } ], "x-deprecated": "use SortKey with SortField union type instead" }, "sortKey": { "allOf": [ { "$ref": "#/definitions/SortKey" } ], "description": "Field to sort by. Includes both field and property-based sorting." }, "additionalSortKeys": { "type": "array", "items": { "$ref": "#/definitions/SortKeyWithDirection" }, "description": "Optional secondary sort keys for tiebreaking. Applied in order after the primary sortKey. Each entry specifies its own sort key and direction. If empty or absent, ties are broken by UUID only." } }, "required": [ "isDescending" ] }, "SortProperty": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" } }, "required": [ "name" ] }, "TimeRangeFilter": { "description": "searches for runs that have at least some intersection with the specified range.", "type": "object", "properties": { "start": { "$ref": "#/definitions/UtcTimestamp" }, "end": { "$ref": "#/definitions/UtcTimestamp" } } }, "TimeframeFilter": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "custom", "preset" ] }, "custom": { "$ref": "#/definitions/CustomTimeframeFilter" }, "preset": { "$ref": "#/definitions/PresetTimeframeFilter" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "custom", "custom": { "startTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 }, "endTime": { "secondsSinceEpoch": 1, "offsetNanoseconds": 1 } } } }, "UnarchiveRunsRequest": { "type": "object", "properties": { "rids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "uniqueItems": true }, "includeLinkedWorkbooks": { "type": "boolean", "description": "If true, all auto-archived workbooks that are linked to run will be unarchived as well. Defaults to false." } }, "example": { "rids": [ "<run rid>" ], "includeLinkedWorkbooks": true } }, "UpdateAttachmentsRequest": { "type": "object", "properties": { "attachmentsToAdd": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AttachmentRid" }, "uniqueItems": true }, "attachmentsToRemove": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AttachmentRid" }, "uniqueItems": true } }, "example": { "attachmentsToAdd": [ "<attachment rid>" ], "attachmentsToRemove": [ "<attachment rid>" ] } }, "UpdateRunRequest": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "startTime": { "allOf": [ { "$ref": "#/definitions/UtcTimestamp" } ], "description": "If strictOverwrite is false, will only update the startTime if it is before the existing startTime." }, "endTime": { "allOf": [ { "$ref": "#/definitions/UtcTimestamp" } ], "description": "If strictOverwrite is false, will only update the endTime if it is after the existing endTime." }, "properties": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "PropertyValue" }, "x-map-key": "PropertyName", "x-deprecated": "use typedProperties" }, "typedProperties": { "type": "object", "additionalProperties": { "$ref": "#/definitions/TypedPropertyValue" }, "x-map-key": "PropertyName" }, "labels": { "type": "array", "items": { "type": "string", "x-alias": "Label" }, "uniqueItems": true }, "links": { "type": "array", "items": { "$ref": "#/definitions/Link" } }, "runPrefix": { "type": "string", "description": "Pass in an empty string to remove the run prefix." }, "dataSources": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CreateRunDataSource" }, "x-map-key": "DataSourceRefName" }, "attachments": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AttachmentRid" }, "uniqueItems": true }, "asset": { "type": "string", "format": "rid", "x-alias": "AssetRid", "x-deprecated": "Use assets" }, "assets": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } }, "strictOverwrite": { "type": "boolean", "description": "If true, will blindly overwrite the existing fields with the new values in the request. If false, will only update the fields if application constraints are maintained. See individual field docs for more details. Defaults to true for backwards compatibility." } }, "example": { "title": "<title>", "description": "<description>", "startTime": { "secondsSinceEpoch": 1 }, "endTime": { "secondsSinceEpoch": 1 }, "properties": { "<key>": "<property value>" }, "typedProperties": { "<key>": { "type": "stringValue", "stringValue": "<property value>" } }, "labels": [ "<label>" ], "links": [ { "url": "<url>" } ], "runPrefix": "<run prefix>", "dataSources": { "<key>": { "dataSource": { "type": "dataset", "dataset": "<dataset rid>" }, "dataSourceRid": "<data source rid>", "offset": { "seconds": 1, "nanos": 1 }, "seriesTags": { "<key>": "<tag value>" } } }, "attachments": [ "<attachment rid>" ], "asset": "<asset rid>", "assets": [ "<asset rid>" ], "strictOverwrite": true } }, "UtcTimestamp": { "type": "object", "properties": { "secondsSinceEpoch": { "type": "integer", "format": "int64" }, "offsetNanoseconds": { "type": "integer", "format": "int64" } }, "required": [ "secondsSinceEpoch" ] }, "WeakTimestampType": { "description": "If a CSV data source is still being split, the timestamp type is not known.", "type": "string", "enum": [ "ABSOLUTE", "RELATIVE", "PENDING" ] } }, "tags": [ { "name": "Run Service", "x-displayName": "Run service", "description": "Runs are collections of channels and metadata from one or more data sources, synchronized over a range of real time, which represents a test event or simulation. These API endpoints let you manage runs in the Nominal app.", "x-errors": [ { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:BothAssetAndDataSourcesSpecified" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:InvalidConnectionRid" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:InvalidDatasetRid" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:InvalidLogSetRid" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:InvalidVideoRid" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:UnspecifiedAssetForMultiAssetRun" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:AssetNotPresentInRun" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:RunPropertiesHaveNullValues" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:RunBoundsInverted" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Scout:InvalidDataSourceRefNameType" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "Scout:RunNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "Scout:RunNotFoundById" }, { "status": 409, "errorCode": "CONFLICT", "errorName": "Scout:RefNamesAlreadyUsed" }, { "status": 409, "errorCode": "CONFLICT", "errorName": "Scout:RunsLocked", "description": "A run under a retention lock is immutable. The runs named here must be unlocked before any of their metadata, data sources, or attachments can be updated. Batch updates are rejected in full rather than partially applied, so this lists every locked run in the request." } ] } ] }