{ "swagger": "2.0", "info": { "title": "Saved view 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/saved-views/v1": { "post": { "operationId": "SavedViewService_createSavedView", "summary": "Create saved view", "tags": [ "Saved View Service" ], "description": "Creates a new saved view in the given workspace. If no workspace is specified, it is created in the user's default workspace.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/CreateSavedViewRequest" }, "required": true, "x-example": { "title": "", "searchState": { "type": "asset", "asset": { "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>" }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } } } } } } } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CreateSavedViewResponse" }, "x-example": { "savedView": { "metadata": { "rid": "<saved view rid>", "resourceType": "ASSET", "title": "<title>", "symbol": { "type": "icon", "icon": "<icon>" }, "color": { "type": "hexCode", "hexCode": "<hex code>" }, "isArchived": true, "createdAt": "2026-01-01T00:00:00Z", "createdBy": "<user rid>", "updatedAt": "2026-01-01T00:00:00Z" }, "searchState": { "type": "asset", "asset": { "sort": { "isDescending": true, "field": "NAME", "sortKey": { "type": "field", "field": "NAME" } }, "groupBy": [ "<column id>" ], "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>", "description": "<description>", "symbol": { "type": "icon", "icon": "<icon>" } }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } }, "style": { "type": "RAW", "value": [ { "value": 1, "color": "<color>", "label": "<label>" } ] } } } } } } } } } } } } }, "/scout/saved-views/v1/{savedViewRid}": { "get": { "operationId": "SavedViewService_getSavedView", "summary": "Get saved view", "tags": [ "Saved View Service" ], "description": "Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.", "parameters": [ { "name": "savedViewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "SavedViewRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSavedViewResponse" }, "x-example": { "savedView": { "metadata": { "rid": "<saved view rid>", "resourceType": "ASSET", "title": "<title>", "symbol": { "type": "icon", "icon": "<icon>" }, "color": { "type": "hexCode", "hexCode": "<hex code>" }, "isArchived": true, "createdAt": "2026-01-01T00:00:00Z", "createdBy": "<user rid>", "updatedAt": "2026-01-01T00:00:00Z" }, "searchState": { "type": "asset", "asset": { "sort": { "isDescending": true, "field": "NAME", "sortKey": { "type": "field", "field": "NAME" } }, "groupBy": [ "<column id>" ], "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>", "description": "<description>", "symbol": { "type": "icon", "icon": "<icon>" } }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } }, "style": { "type": "RAW", "value": [ { "value": 1, "color": "<color>", "label": "<label>" } ] } } } } } } } } } } } }, "put": { "operationId": "SavedViewService_updateSavedView", "summary": "Update saved view", "tags": [ "Saved View Service" ], "description": "Updates metadata, search filters, or display settings for an existing saved view. Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.", "parameters": [ { "name": "savedViewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "SavedViewRid", "required": true }, { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/UpdateSavedViewRequest" }, "required": true, "x-example": { "title": "<title>", "symbol": { "type": "symbol", "symbol": { "type": "icon", "icon": "<icon>" } }, "color": { "type": "color", "color": { "type": "hexCode", "hexCode": "<hex code>" } }, "searchState": { "type": "asset", "asset": { "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>" }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } } } } } } } }, "index": 1 } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UpdateSavedViewResponse" }, "x-example": { "savedView": { "metadata": { "rid": "<saved view rid>", "resourceType": "ASSET", "title": "<title>", "symbol": { "type": "icon", "icon": "<icon>" }, "color": { "type": "hexCode", "hexCode": "<hex code>" }, "isArchived": true, "createdAt": "2026-01-01T00:00:00Z", "createdBy": "<user rid>", "updatedAt": "2026-01-01T00:00:00Z" }, "searchState": { "type": "asset", "asset": { "sort": { "isDescending": true, "field": "NAME", "sortKey": { "type": "field", "field": "NAME" } }, "groupBy": [ "<column id>" ], "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>", "description": "<description>", "symbol": { "type": "icon", "icon": "<icon>" } }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } }, "style": { "type": "RAW", "value": [ { "value": 1, "color": "<color>", "label": "<label>" } ] } } } } } } } } } } } } }, "/scout/saved-views/v1/batch-get": { "post": { "operationId": "SavedViewService_batchGetSavedViews", "summary": "Batch get saved views", "tags": [ "Saved View Service" ], "description": "Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.", "parameters": [ { "name": "savedViewRids", "in": "body", "schema": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "SavedViewRid" }, "uniqueItems": true, "example": [ "<saved view rid>" ] }, "required": false, "x-example": [ "<saved view rid>" ] } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchGetSavedViewsResponse" }, "x-example": { "savedViews": [ { "metadata": { "rid": "<saved view rid>", "resourceType": "ASSET", "title": "<title>", "symbol": { "type": "icon", "icon": "<icon>" }, "color": { "type": "hexCode", "hexCode": "<hex code>" }, "isArchived": true, "createdAt": "2026-01-01T00:00:00Z", "createdBy": "<user rid>", "updatedAt": "2026-01-01T00:00:00Z" }, "searchState": { "type": "asset", "asset": { "sort": { "isDescending": true, "field": "NAME", "sortKey": { "type": "field", "field": "NAME" } }, "groupBy": [ "<column id>" ], "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>", "description": "<description>", "symbol": { "type": "icon", "icon": "<icon>" } }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } }, "style": { "type": "RAW", "value": [ { "value": 1, "color": "<color>", "label": "<label>" } ] } } } } } } } } ] } } } } }, "/scout/saved-views/v1/search": { "post": { "operationId": "SavedViewService_searchSavedViews", "summary": "Search saved views", "tags": [ "Saved View Service" ], "description": "Searches for saved views using a nested query expression. Supports pagination.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/SearchSavedViewsRequest" }, "required": true, "x-example": { "sort": { "isDescending": true, "sortKey": { "type": "field", "field": "TITLE" } }, "query": { "type": "and", "and": { "queries": [] } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchSavedViewsResponse" }, "x-example": { "savedViews": [ { "rid": "<saved view rid>", "resourceType": "ASSET", "title": "<title>", "symbol": { "type": "icon", "icon": "<icon>" }, "color": { "type": "hexCode", "hexCode": "<hex code>" }, "isArchived": true, "createdAt": "2026-01-01T00:00:00Z", "createdBy": "<user rid>", "updatedAt": "2026-01-01T00:00:00Z" } ], "nextPageToken": "<token>" } } } } }, "/scout/saved-views/v1/{savedViewRid}/archive": { "post": { "operationId": "SavedViewService_archiveSavedView", "summary": "Archive saved view", "tags": [ "Saved View Service" ], "description": "Archives the specified saved view. Archived views are hidden from search.", "parameters": [ { "name": "savedViewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "SavedViewRid", "required": true } ], "responses": { "204": { "description": "No content." } } } }, "/scout/saved-views/v1/{savedViewRid}/unarchive": { "post": { "operationId": "SavedViewService_unarchiveSavedView", "summary": "Unarchive saved view", "tags": [ "Saved View Service" ], "description": "Restores archived saved view, making them discoverable in search again.", "parameters": [ { "name": "savedViewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "SavedViewRid", "required": true } ], "responses": { "204": { "description": "No content." } } } } }, "definitions": { "ArchivedStatus": { "type": "string", "enum": [ "NOT_ARCHIVED", "ARCHIVED" ] }, "Empty": { "type": "object", "properties": {} }, "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" ] }, "Timestamp": { "description": "Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants in proto APIs.\n\nThis legacy nanosecond precision timestamp type is represented by an epoch time in seconds and a nanosecond offset. The nanosecond offset is from the start of the epoch second, so must be less than 1 billion.", "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "nanos": { "type": "integer", "format": "int64" } }, "required": [ "seconds", "nanos" ] }, "event.AssetsFilter": { "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "assets": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } } }, "required": [ "operator" ] }, "AssigneesFilter": { "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "assignees": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" } } }, "required": [ "operator" ] }, "DataReviewChecksFilter": { "type": "object", "properties": { "dataReviewChecks": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "CheckRid" } } } }, "DataReviewsFilter": { "type": "object", "properties": { "dataReviews": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" } } } }, "EventDispositionStatus": { "type": "string", "enum": [ "PENDING_REVIEW", "CLOSED_IGNORED", "CLOSED_REQUIRES_FURTHER_ACTION", "NO_DISPOSITION" ] }, "EventTimeFilter": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "timestampCondition": { "$ref": "#/definitions/EventTimeFilterCondition" } }, "required": [ "timestamp", "timestampCondition" ] }, "EventTimeFilterCondition": { "type": "string", "enum": [ "START_TIME_BEFORE_INCLUSIVE", "START_TIME_BEFORE_EXCLUSIVE", "START_TIME_AFTER_INCLUSIVE", "START_TIME_AFTER_EXCLUSIVE", "END_TIME_BEFORE_INCLUSIVE", "END_TIME_BEFORE_EXCLUSIVE", "END_TIME_AFTER_INCLUSIVE", "END_TIME_AFTER_EXCLUSIVE" ] }, "EventType": { "type": "string", "enum": [ "INFO", "FLAG", "ERROR", "SUCCESS" ] }, "OriginTypesFilter": { "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "originTypes": { "type": "array", "items": { "$ref": "#/definitions/SearchEventOriginType" } } }, "required": [ "operator" ] }, "SearchEventOriginType": { "type": "string", "enum": [ "WORKBOOK", "TEMPLATE", "API", "DATA_REVIEW", "PROCEDURE", "STREAMING_CHECKLIST" ] }, "event.SearchQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "archived", "searchText", "exactMatch", "after", "before", "advancedTimeFilter", "asset", "assets", "template", "workbook", "dataReview", "dataReviews", "originType", "originTypes", "dataReviewCheck", "dataReviewChecks", "dispositionStatus", "dispositionStatuses", "priority", "priorities", "assignee", "assignees", "eventType", "eventTypes", "createdBy", "createdByAnyOf", "label", "labels", "property", "properties", "and", "or", "not", "workspace", "procedure", "procedureExecution", "stepId", "streamingChecklist", "streamingCheck", "numericProperty", "numericPropertyRange" ] }, "archived": { "type": "boolean" }, "searchText": { "type": "string", "description": "Search text to perform fuzzy searching against." }, "exactMatch": { "type": "string", "description": "Search text to perform exact matching against on the event name and description." }, "after": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time." }, "before": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time." }, "advancedTimeFilter": { "$ref": "#/definitions/EventTimeFilter" }, "asset": { "type": "string", "format": "rid", "x-alias": "AssetRid", "x-deprecated": "use assetRids" }, "assets": { "$ref": "#/definitions/event.AssetsFilter" }, "template": { "type": "string", "format": "rid", "x-alias": "TemplateRid" }, "workbook": { "type": "string", "format": "rid", "x-alias": "NotebookRid" }, "dataReview": { "type": "string", "format": "rid", "x-alias": "DataReviewRid", "x-deprecated": "use dataReviews instead" }, "dataReviews": { "$ref": "#/definitions/DataReviewsFilter" }, "originType": { "allOf": [ { "$ref": "#/definitions/SearchEventOriginType" } ], "x-deprecated": "use originTypes instead" }, "originTypes": { "$ref": "#/definitions/OriginTypesFilter" }, "dataReviewCheck": { "type": "string", "format": "rid", "x-alias": "CheckRid", "x-deprecated": "use dataReviewChecks instead" }, "dataReviewChecks": { "$ref": "#/definitions/DataReviewChecksFilter" }, "dispositionStatus": { "allOf": [ { "$ref": "#/definitions/EventDispositionStatus" } ], "x-deprecated": "use dispositionStatuses instead" }, "dispositionStatuses": { "type": "array", "items": { "$ref": "#/definitions/EventDispositionStatus" } }, "priority": { "allOf": [ { "$ref": "#/definitions/Priority" } ], "x-deprecated": "use priorities instead" }, "priorities": { "type": "array", "items": { "$ref": "#/definitions/Priority" } }, "assignee": { "type": "string", "format": "rid", "x-alias": "UserRid", "x-deprecated": "use assignees instead" }, "assignees": { "$ref": "#/definitions/AssigneesFilter" }, "eventType": { "allOf": [ { "$ref": "#/definitions/EventType" } ], "x-deprecated": "use eventTypes instead" }, "eventTypes": { "type": "array", "items": { "$ref": "#/definitions/EventType" } }, "createdBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "createdByAnyOf": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "label": { "type": "string", "x-alias": "Label", "x-deprecated": "use labels instead" }, "labels": { "$ref": "#/definitions/LabelsFilter" }, "property": { "allOf": [ { "$ref": "#/definitions/Property" } ], "x-deprecated": "use properties instead" }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "and": { "type": "array", "items": { "$ref": "#/definitions/event.SearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/event.SearchQuery" } }, "not": { "$ref": "#/definitions/event.SearchQuery" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "procedure": { "type": "string", "format": "rid", "x-alias": "ProcedureRid" }, "procedureExecution": { "type": "string", "format": "rid", "x-alias": "ProcedureExecutionRid" }, "stepId": { "type": "string" }, "streamingChecklist": { "type": "string", "format": "rid", "x-alias": "ChecklistRid", "description": "Filters to events created from a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance." }, "streamingCheck": { "type": "string", "format": "rid", "x-alias": "CheckRid", "description": "Filters to events created from the check of a checklist executing in streaming. Use `assets` to further filter to a specific streaming checklist instance." }, "numericProperty": { "allOf": [ { "$ref": "#/definitions/NumericPropertyPredicate" } ], "description": "Matches events using a numeric property comparison." }, "numericPropertyRange": { "allOf": [ { "$ref": "#/definitions/NumericPropertyRangePredicate" } ], "description": "Matches events using an inclusive numeric property range." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "archived", "archived": true } }, "Color": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "hexCode" ] }, "hexCode": { "type": "string" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "hexCode", "hexCode": "string" } }, "Priority": { "type": "string", "enum": [ "P0", "P1", "P2", "P3", "P4" ] }, "Symbol": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "icon", "emoji", "image" ] }, "icon": { "type": "string", "description": "Icon name (e.g. castle)" }, "emoji": { "type": "string", "description": "Emoji name (e.g. :castle:)" }, "image": { "type": "string", "description": "Image url (e.g. https://example.com/image.png)" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "icon", "icon": "string" } }, "AssetSortField": { "type": "string", "enum": [ "NAME", "CREATED_AT", "MOST_RECENT_RUN_START" ] }, "AssetSortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "allOf": [ { "$ref": "#/definitions/AssetSortField" } ], "x-deprecated": "use SortKey with SortField union type instead" }, "sortKey": { "allOf": [ { "$ref": "#/definitions/asset.api.SortKey" } ], "description": "Field to sort by. Includes both field and property-based sorting. Must be supplied if field is not provided separately." } }, "required": [ "isDescending" ] }, "AssetTypesFilter": { "description": "Matches an asset when any of its types is in assetTypes.", "type": "object", "properties": { "assetTypes": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "TypeRid" } } } }, "SearchAssetsQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "searchText", "exactSubstring", "label", "labels", "property", "propertyKey", "properties", "numericProperty", "numericPropertyRange", "typeRid", "assetTypes", "isStaged", "archived", "and", "or", "not", "workspace" ] }, "searchText": { "type": "string" }, "exactSubstring": { "type": "string", "description": "An case-insensitive substring match of the title or description of the asset." }, "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 assets that have a property with this key, regardless of value." }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "numericProperty": { "allOf": [ { "$ref": "#/definitions/NumericPropertyPredicate" } ], "description": "Matches assets using a numeric property comparison." }, "numericPropertyRange": { "allOf": [ { "$ref": "#/definitions/NumericPropertyRangePredicate" } ], "description": "Matches assets using an inclusive numeric property range." }, "typeRid": { "type": "string", "format": "rid", "x-alias": "TypeRid", "x-deprecated": "use assetTypes" }, "assetTypes": { "$ref": "#/definitions/AssetTypesFilter" }, "isStaged": { "type": "boolean", "x-deprecated": "staged assets are no longer returned in the search endpoint" }, "archived": { "type": "boolean" }, "and": { "type": "array", "items": { "$ref": "#/definitions/SearchAssetsQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/SearchAssetsQuery" } }, "not": { "$ref": "#/definitions/SearchAssetsQuery" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "searchText", "searchText": "string" } }, "asset.api.SortKey": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "field", "property", "numericProperty" ] }, "field": { "$ref": "#/definitions/AssetSortField" }, "property": { "$ref": "#/definitions/asset.api.SortProperty" }, "numericProperty": { "allOf": [ { "$ref": "#/definitions/asset.api.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" } }, "asset.api.SortProperty": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" } }, "required": [ "name" ] }, "ChecklistSearchQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "and", "or", "searchText", "label", "labels", "property", "properties", "authorRid", "assigneeRid", "isPublished", "not", "workspace", "authorIsCurrentUser", "authorRids", "isArchived" ] }, "and": { "type": "array", "items": { "$ref": "#/definitions/ChecklistSearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/ChecklistSearchQuery" } }, "searchText": { "type": "string" }, "label": { "type": "string", "x-alias": "Label", "x-deprecated": "use labels instead" }, "labels": { "$ref": "#/definitions/LabelsFilter" }, "property": { "allOf": [ { "$ref": "#/definitions/Property" } ], "x-deprecated": "use properties" }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "authorRid": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "assigneeRid": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "isPublished": { "type": "boolean" }, "not": { "$ref": "#/definitions/ChecklistSearchQuery" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "authorIsCurrentUser": { "type": "boolean" }, "authorRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true }, "isArchived": { "type": "boolean" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "and", "and": [] } }, "checks.api.SortField": { "type": "string", "enum": [ "CREATED_AT", "LAST_USED", "UPDATED_AT" ] }, "checks.api.SortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "$ref": "#/definitions/checks.api.SortField" } }, "required": [ "isDescending", "field" ] }, "Operator": { "type": "string", "enum": [ "LEQ", "LT", "GEQ", "GT", "EQ" ] }, "notebook.api.AssetsFilter": { "description": "for an exact match, use the exactAssetRids filter", "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "assets": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } } }, "required": [ "operator" ] }, "NotebookType": { "description": "The kind of workbook. Persisted on metadata, so it is readable without loading content and filterable through `notebookTypes`.", "type": "string", "enum": [ "WORKBOOK", "COMPARISON_WORKBOOK", "ANALYST_EPHEMERAL_WORKBOOK", "REPORT" ] }, "NotebookTypesFilter": { "description": "returns notebooks that match any of the provided notebook types", "type": "object", "properties": { "types": { "type": "array", "items": { "$ref": "#/definitions/NotebookType" } } } }, "RunsFilter": { "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "runs": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" } } }, "required": [ "operator" ] }, "SearchNotebooksQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "and", "or", "not", "exactMatch", "searchText", "label", "labels", "property", "properties", "assetRid", "assetRids", "exactAssetRids", "authorRid", "runRid", "runRids", "notebookType", "notebookTypes", "draftState", "archived", "workspace", "authorIsCurrentUser", "authorRids" ] }, "and": { "type": "array", "items": { "$ref": "#/definitions/SearchNotebooksQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/SearchNotebooksQuery" } }, "not": { "$ref": "#/definitions/SearchNotebooksQuery" }, "exactMatch": { "type": "string", "description": "Performs case insensitive exact match search on the title." }, "searchText": { "type": "string" }, "label": { "type": "string", "x-alias": "Label", "x-deprecated": "use labels" }, "labels": { "$ref": "#/definitions/LabelsFilter" }, "property": { "allOf": [ { "$ref": "#/definitions/Property" } ], "x-deprecated": "use properties" }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "assetRid": { "type": "string", "format": "rid", "x-alias": "AssetRid", "x-deprecated": "use assetRids" }, "assetRids": { "$ref": "#/definitions/notebook.api.AssetsFilter" }, "exactAssetRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "uniqueItems": true, "description": "Requires the set of assets in the query to exactly match the set of assets in the notebook. To do a partial match, use an assetRids query." }, "authorRid": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "runRid": { "type": "string", "format": "rid", "x-alias": "RunRid", "x-deprecated": "use runRids" }, "runRids": { "$ref": "#/definitions/RunsFilter" }, "notebookType": { "allOf": [ { "$ref": "#/definitions/NotebookType" } ], "x-deprecated": "use notebook types" }, "notebookTypes": { "$ref": "#/definitions/NotebookTypesFilter" }, "draftState": { "type": "boolean" }, "archived": { "type": "boolean" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "authorIsCurrentUser": { "type": "boolean" }, "authorRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "and", "and": [] } }, "notebook.api.SortBy": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "$ref": "#/definitions/notebook.api.SortByField" } }, "required": [ "isDescending", "field" ] }, "notebook.api.SortByField": { "type": "string", "enum": [ "NAME", "CREATED_AT", "UPDATED_AT" ] }, "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" ] }, "run.api.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" } } } }, "CheckAlertStatesFilter": { "type": "object", "properties": { "checkAlertState": { "$ref": "#/definitions/CheckAlertState" }, "operator": { "$ref": "#/definitions/Operator" }, "threshold": { "type": "integer", "format": "int64" } }, "required": [ "checkAlertState", "operator", "threshold" ] }, "CustomTimeframeFilter": { "type": "object", "properties": { "startTime": { "$ref": "#/definitions/UtcTimestamp" }, "endTime": { "$ref": "#/definitions/UtcTimestamp" } } }, "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" ] }, "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" ] }, "api.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/run.api.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/api.SearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/api.SearchQuery" } }, "not": { "$ref": "#/definitions/api.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 } } }, "run.api.SortField": { "type": "string", "enum": [ "NAME", "ID", "CREATED_AT", "START_TIME", "END_TIME", "PENDING_CHECK_ALERTS" ] }, "run.api.SortKey": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "field", "property", "numericProperty" ] }, "field": { "$ref": "#/definitions/run.api.SortField" }, "property": { "allOf": [ { "$ref": "#/definitions/run.api.SortProperty" } ], "description": "Sort by a property value. Requires a property name, and will always sort null values last." }, "numericProperty": { "allOf": [ { "$ref": "#/definitions/run.api.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/run.api.SortKey" }, "isDescending": { "type": "boolean" } }, "required": [ "sortKey", "isDescending" ] }, "run.api.SortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "allOf": [ { "$ref": "#/definitions/run.api.SortField" } ], "x-deprecated": "use SortKey with SortField union type instead" }, "sortKey": { "allOf": [ { "$ref": "#/definitions/run.api.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" ] }, "run.api.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 } } } }, "UtcTimestamp": { "type": "object", "properties": { "secondsSinceEpoch": { "type": "integer", "format": "int64" }, "offsetNanoseconds": { "type": "integer", "format": "int64" } }, "required": [ "secondsSinceEpoch" ] }, "AssetMetricColumn": { "type": "object", "properties": { "metadata": { "$ref": "#/definitions/MetricColumnMetadata" }, "timeRange": { "$ref": "#/definitions/AssetMetricColumnTimeRange" }, "aggregation": { "$ref": "#/definitions/MetricColumnAggregation" }, "data": { "$ref": "#/definitions/MetricColumnData" }, "style": { "$ref": "#/definitions/MetricColumnStyle" } }, "required": [ "metadata", "timeRange", "aggregation", "data" ] }, "AssetMetricColumnTimeRange": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "mostRecentRun", "custom", "preset" ] }, "mostRecentRun": { "$ref": "#/definitions/MostRecentRun" }, "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": "mostRecentRun", "mostRecentRun": {} } }, "AssetMetricColumns": { "type": "object", "properties": { "metricColumns": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AssetMetricColumn" }, "x-map-key": "ColumnId" } } }, "AssetSearchState": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/AssetSortOptions" }, "groupBy": { "type": "array", "items": { "type": "string", "x-alias": "ColumnId" } }, "query": { "$ref": "#/definitions/SearchAssetsQuery" } }, "required": [ "query" ] }, "AssetsFilterOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "BatchGetSavedViewsResponse": { "type": "object", "properties": { "savedViews": { "type": "array", "items": { "$ref": "#/definitions/SavedView" }, "uniqueItems": true } } }, "ChecklistSearchState": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/checks.api.SortOptions" }, "query": { "$ref": "#/definitions/ChecklistSearchQuery" } }, "required": [ "query" ] }, "ColumnPinningState": { "type": "object", "properties": { "left": { "type": "array", "items": { "type": "string", "x-alias": "ColumnId" } }, "right": { "type": "array", "items": { "type": "string", "x-alias": "ColumnId" } } } }, "CreateSavedViewRequest": { "type": "object", "properties": { "title": { "type": "string" }, "symbol": { "$ref": "#/definitions/Symbol" }, "color": { "$ref": "#/definitions/Color" }, "searchState": { "$ref": "#/definitions/SearchState" }, "displayState": { "$ref": "#/definitions/DisplayState" }, "workspaceRid": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" } }, "required": [ "title", "searchState", "displayState" ], "example": { "title": "<title>", "searchState": { "type": "asset", "asset": { "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>" }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } } } } } } } } } }, "CreateSavedViewResponse": { "type": "object", "properties": { "savedView": { "$ref": "#/definitions/SavedView" } }, "required": [ "savedView" ] }, "DisplayState": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "displayStateV1" ] }, "displayStateV1": { "$ref": "#/definitions/TableState" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "key": true }, "columnSizing": { "key": 1 }, "columnOrder": [ "string" ], "columnPinning": { "left": [ "string" ], "right": [ "string" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "key": { "metadata": { "title": "string", "description": "string", "symbol": { "type": "icon", "icon": "string" } }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } }, "style": { "type": "RAW", "value": [ { "value": 1, "color": "string", "label": "string" } ] } } } } } } } }, "GetSavedViewResponse": { "type": "object", "properties": { "savedView": { "$ref": "#/definitions/SavedView" } }, "required": [ "savedView" ] }, "MetricColumnAggregation": { "type": "string", "enum": [ "TOTAL_COUNT", "TOTAL_DURATION" ] }, "MetricColumnData": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "event" ] }, "event": { "$ref": "#/definitions/event.SearchQuery" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "event", "event": { "type": "archived", "archived": true } } }, "MetricColumnMetadata": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "symbol": { "$ref": "#/definitions/Symbol" } }, "required": [ "title" ] }, "MetricColumnStyle": { "type": "object", "properties": { "type": { "$ref": "#/definitions/MetricColumnThresholdType" }, "value": { "type": "array", "items": { "$ref": "#/definitions/MetricColumnThreshold" } } }, "required": [ "type" ] }, "MetricColumnThreshold": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "color": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "color" ] }, "MetricColumnThresholdType": { "type": "string", "enum": [ "RAW", "BAR" ] }, "MetricColumns": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "asset" ] }, "asset": { "$ref": "#/definitions/AssetMetricColumns" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "asset", "asset": { "metricColumns": { "key": { "metadata": { "title": "string", "description": "string", "symbol": { "type": "icon", "icon": "string" } }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } }, "style": { "type": "RAW", "value": [ { "value": 1, "color": "string", "label": "string" } ] } } } } } }, "MostRecentRun": { "type": "object", "properties": {} }, "ProcedureExecutionAssetsFilter": { "type": "object", "properties": { "assetRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" } }, "operator": { "$ref": "#/definitions/AssetsFilterOperator" } }, "required": [ "operator" ] }, "ProcedureExecutionProgressStatus": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "FINISHED", "ABORTED" ] }, "ProcedureExecutionSearchQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "searchText", "label", "property", "and", "or", "workspace", "procedureRid", "commitId", "createdBy", "progressStatus", "assetsFilter", "isArchived" ] }, "searchText": { "type": "string" }, "label": { "type": "string", "x-alias": "Label" }, "property": { "$ref": "#/definitions/Property" }, "and": { "type": "array", "items": { "$ref": "#/definitions/ProcedureExecutionSearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/ProcedureExecutionSearchQuery" } }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "procedureRid": { "type": "string", "format": "rid", "x-alias": "ProcedureRid" }, "commitId": { "type": "string", "x-alias": "CommitId" }, "createdBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "progressStatus": { "$ref": "#/definitions/ProcedureExecutionProgressStatus" }, "assetsFilter": { "$ref": "#/definitions/ProcedureExecutionAssetsFilter" }, "isArchived": { "type": "boolean" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "searchText", "searchText": "string" } }, "ProcedureExecutionSearchState": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/ProcedureExecutionSortOptions" }, "query": { "$ref": "#/definitions/ProcedureExecutionSearchQuery" } }, "required": [ "query" ] }, "ProcedureExecutionSortField": { "type": "string", "enum": [ "CREATED_AT", "STARTED_AT", "FINISHED_AT", "UPDATED_AT" ] }, "ProcedureExecutionSortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "sortField": { "$ref": "#/definitions/ProcedureExecutionSortField" } }, "required": [ "sortField" ] }, "ProcedureSearchQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "searchText", "label", "property", "and", "or", "workspace", "createdBy", "isArchived" ] }, "searchText": { "type": "string" }, "label": { "type": "string", "x-alias": "Label" }, "property": { "$ref": "#/definitions/Property" }, "and": { "type": "array", "items": { "$ref": "#/definitions/ProcedureSearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/ProcedureSearchQuery" } }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "createdBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "isArchived": { "type": "boolean" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "searchText", "searchText": "string" } }, "ProcedureSearchState": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/ProcedureSortOptions" }, "query": { "$ref": "#/definitions/ProcedureSearchQuery" } }, "required": [ "query" ] }, "ProcedureSortField": { "type": "string", "enum": [ "NAME", "CREATED_AT", "UPDATED_AT" ] }, "ProcedureSortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "sortField": { "$ref": "#/definitions/ProcedureSortField" } } }, "ResourceType": { "type": "string", "enum": [ "ASSET", "RUN", "WORKBOOK", "CHECKLIST", "TEMPLATE", "PROCEDURE", "PROCEDURE_EXECUTION" ] }, "RunSearchState": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/run.api.SortOptions" }, "groupBy": { "type": "array", "items": { "type": "string", "x-alias": "ColumnId" } }, "query": { "$ref": "#/definitions/api.SearchQuery" } }, "required": [ "query" ] }, "SavedView": { "type": "object", "properties": { "metadata": { "$ref": "#/definitions/SavedViewMetadata" }, "searchState": { "$ref": "#/definitions/SearchState" }, "displayState": { "$ref": "#/definitions/DisplayState" } }, "required": [ "metadata", "searchState", "displayState" ] }, "SavedViewMetadata": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "SavedViewRid" }, "resourceType": { "$ref": "#/definitions/ResourceType" }, "title": { "type": "string" }, "symbol": { "$ref": "#/definitions/Symbol" }, "color": { "$ref": "#/definitions/Color" }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "rid", "resourceType", "title", "isArchived", "createdAt", "createdBy", "updatedAt" ] }, "SavedViewSortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "sortKey": { "allOf": [ { "$ref": "#/definitions/savedviews.api.SortKey" } ], "description": "Field to sort by." } }, "required": [ "isDescending", "sortKey" ] }, "SearchSavedViewsQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "and", "or", "not", "titleExactSubstringSearch", "resourceType", "workspace" ] }, "and": { "$ref": "#/definitions/SearchSavedViewsQueryList" }, "or": { "$ref": "#/definitions/SearchSavedViewsQueryList" }, "not": { "$ref": "#/definitions/SearchSavedViewsQuery" }, "titleExactSubstringSearch": { "type": "string" }, "resourceType": { "$ref": "#/definitions/ResourceType" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "and", "and": { "queries": [] } } }, "SearchSavedViewsQueryList": { "type": "object", "properties": { "queries": { "type": "array", "items": { "$ref": "#/definitions/SearchSavedViewsQuery" } } } }, "SearchSavedViewsRequest": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/SavedViewSortOptions" }, "pageSize": { "type": "integer", "format": "int32", "description": "Defaults to 100. Will throw if larger than 1_000." }, "nextPageToken": { "type": "string", "x-alias": "Token" }, "query": { "$ref": "#/definitions/SearchSavedViewsQuery" }, "archivedStatuses": { "type": "array", "items": { "$ref": "#/definitions/ArchivedStatus" }, "uniqueItems": true, "description": "Default search status is NOT_ARCHIVED if none are provided. Allows for including archived assets in search." } }, "required": [ "sort", "query" ], "example": { "sort": { "isDescending": true, "sortKey": { "type": "field", "field": "TITLE" } }, "query": { "type": "and", "and": { "queries": [] } } } }, "SearchSavedViewsResponse": { "type": "object", "properties": { "savedViews": { "type": "array", "items": { "$ref": "#/definitions/SavedViewMetadata" } }, "nextPageToken": { "type": "string", "x-alias": "Token" } } }, "SearchState": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "asset", "run", "checklist", "workbook", "template", "procedure", "procedureExecution" ] }, "asset": { "$ref": "#/definitions/AssetSearchState" }, "run": { "$ref": "#/definitions/RunSearchState" }, "checklist": { "$ref": "#/definitions/ChecklistSearchState" }, "workbook": { "$ref": "#/definitions/WorkbookSearchState" }, "template": { "$ref": "#/definitions/TemplateSearchState" }, "procedure": { "$ref": "#/definitions/ProcedureSearchState" }, "procedureExecution": { "$ref": "#/definitions/ProcedureExecutionSearchState" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "asset", "asset": { "sort": { "isDescending": true, "field": "NAME", "sortKey": { "type": "field", "field": "NAME" } }, "groupBy": [ "string" ], "query": { "type": "searchText", "searchText": "string" } } } }, "savedviews.api.SortField": { "type": "string", "enum": [ "TITLE", "CREATED_AT", "USER_DEFINED" ] }, "savedviews.api.SortKey": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "field" ] }, "field": { "$ref": "#/definitions/savedviews.api.SortField" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "field", "field": "TITLE" } }, "TableState": { "type": "object", "properties": { "columnVisibility": { "type": "object", "additionalProperties": { "type": "boolean" }, "x-map-key": "ColumnId" }, "columnSizing": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "x-map-key": "ColumnId" }, "columnOrder": { "type": "array", "items": { "type": "string", "x-alias": "ColumnId" } }, "columnPinning": { "$ref": "#/definitions/ColumnPinningState" }, "metricColumns": { "$ref": "#/definitions/MetricColumns" } } }, "TemplateSearchState": { "type": "object", "properties": { "sort": { "allOf": [ { "$ref": "#/definitions/template.api.SortBy" } ], "description": "Sort for templates view. Uses BE-supplied default if empty." }, "query": { "$ref": "#/definitions/SearchTemplatesQuery" } }, "required": [ "query" ] }, "UpdateColor": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "color", "clearColor" ] }, "color": { "$ref": "#/definitions/Color" }, "clearColor": { "$ref": "#/definitions/Empty" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "color", "color": { "type": "hexCode", "hexCode": "string" } } }, "UpdateSavedViewRequest": { "type": "object", "properties": { "title": { "type": "string" }, "symbol": { "$ref": "#/definitions/UpdateSymbol" }, "color": { "$ref": "#/definitions/UpdateColor" }, "searchState": { "$ref": "#/definitions/SearchState" }, "displayState": { "$ref": "#/definitions/DisplayState" }, "index": { "type": "integer", "format": "int32" } }, "example": { "title": "<title>", "symbol": { "type": "symbol", "symbol": { "type": "icon", "icon": "<icon>" } }, "color": { "type": "color", "color": { "type": "hexCode", "hexCode": "<hex code>" } }, "searchState": { "type": "asset", "asset": { "query": { "type": "searchText", "searchText": "<search text>" } } }, "displayState": { "type": "displayStateV1", "displayStateV1": { "columnVisibility": { "<key>": true }, "columnSizing": { "<key>": 1 }, "columnOrder": [ "<column id>" ], "columnPinning": { "left": [ "<column id>" ], "right": [ "<column id>" ] }, "metricColumns": { "type": "asset", "asset": { "metricColumns": { "<key>": { "metadata": { "title": "<title>" }, "timeRange": { "type": "mostRecentRun", "mostRecentRun": {} }, "aggregation": "TOTAL_COUNT", "data": { "type": "event", "event": { "type": "archived", "archived": true } } } } } } } }, "index": 1 } }, "UpdateSavedViewResponse": { "type": "object", "properties": { "savedView": { "$ref": "#/definitions/SavedView" } }, "required": [ "savedView" ] }, "UpdateSymbol": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "symbol", "clearSymbol" ] }, "symbol": { "$ref": "#/definitions/Symbol" }, "clearSymbol": { "$ref": "#/definitions/Empty" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "symbol", "symbol": { "type": "icon", "icon": "string" } } }, "WorkbookSearchState": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/notebook.api.SortBy" }, "query": { "$ref": "#/definitions/SearchNotebooksQuery" } }, "required": [ "query" ] }, "SearchTemplatesQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "and", "or", "not", "exactMatch", "searchText", "label", "labels", "property", "properties", "createdBy", "isArchived", "isPublished", "workspace", "authorIsCurrentUser", "authorRids" ] }, "and": { "type": "array", "items": { "$ref": "#/definitions/SearchTemplatesQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/SearchTemplatesQuery" } }, "not": { "$ref": "#/definitions/SearchTemplatesQuery" }, "exactMatch": { "type": "string", "description": "Performs case insensitive exact match search on the title." }, "searchText": { "type": "string", "description": "Searches title and description only" }, "label": { "type": "string", "x-alias": "Label", "x-deprecated": "use labels instead" }, "labels": { "$ref": "#/definitions/LabelsFilter" }, "property": { "allOf": [ { "$ref": "#/definitions/Property" } ], "x-deprecated": "use properties" }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "createdBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "isArchived": { "type": "boolean" }, "isPublished": { "type": "boolean" }, "workspace": { "type": "string", "format": "rid", "x-alias": "WorkspaceRid" }, "authorIsCurrentUser": { "type": "boolean" }, "authorRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "and", "and": [] } }, "template.api.SortBy": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "$ref": "#/definitions/template.api.SortByField" } }, "required": [ "isDescending", "field" ] }, "template.api.SortByField": { "description": "UPDATED_AT is an alias for EDITED_AT.", "type": "string", "enum": [ "NAME", "CREATED_AT", "UPDATED_AT", "EDITED_AT" ] } }, "tags": [ { "name": "Saved View Service", "x-displayName": "Saved view service", "description": "Saved Views allow users to store and reuse filter and table display configurations across assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.", "x-errors": [ { "status": 404, "errorCode": "NOT_FOUND", "errorName": "SavedView:SavedViewNotFoundError" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "SavedView:SavedViewsNotFoundError" }, { "status": 500, "errorCode": "INTERNAL", "errorName": "SavedView:ResourceTypeAndSearchStateMismatch" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "SavedView:CannotChangeSavedViewResourceType" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "SavedView:TooManyActiveSavedViews" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "SavedView:InvalidIndex" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "SavedView:CannotUpdateArchivedSavedView" } ] } ] }