{ "schemaVersion": 2, "sources": { "openapi": [ { "file": "contracts/openapi/admin.json", "hash": "81ec255f12fb0620d59905cb0cf9ea8632e0a27b662d6f996b7e8130098a5807", "infoTitle": "Formant admin-api", "infoVersion": "1.297.10", "pathCount": 179, "service": "admin" }, { "file": "contracts/openapi/query.json", "hash": "20829adfb01dc8bfc89f68b9cc9bec38c40877168b8fd559b32bf8855a651e36", "infoTitle": "Formant query-api", "infoVersion": "1.297.10", "pathCount": 22, "service": "query" }, { "file": "contracts/openapi/gateway.json", "hash": "c32c8596490c45496eb9ae6354695d54279a8b42fb98398d701b01ead82c0b78", "infoTitle": "Gateway Service API", "infoVersion": "1.0.0", "pathCount": 1, "service": "gateway" }, { "file": "contracts/openapi/theopolis.json", "hash": "f0579854e4d727e9bb0e3fdc35b7bc76b8e5308f4ee34fe8edbf9580b3f8456c", "infoTitle": "Theopolis API", "infoVersion": "1.0.0", "pathCount": 146, "service": "theopolis" }, { "file": "contracts/openapi/theopolis-legacy.json", "hash": "f0262ec581f9377e83685d9ef0f6c1584ce5848464026244e672a724e06b55bd", "infoTitle": "Theopolis API", "infoVersion": "1.0.0", "pathCount": 104, "service": "theopolis" }, { "file": "contracts/openapi/ingest.json", "hash": "08d92a0d4eb5ae1d56dbeadd78a481b211944fc38b0104523c74afd46ca793df", "infoTitle": "Formant API", "infoVersion": "1.0.0", "pathCount": 21, "service": "ingest" } ], "operationsSource": "src/lib/contracts/operations.ts", "operationsSourceHash": "97d561446cdf5f88eedec56f3688f19f47d1c34eb3e2decb6e58a12f682a6b78" }, "typedOperations": [ { "id": "admin.accounts.children.list", "method": "GET", "pathTemplate": "accounts/{accountId}/children", "stability": "stable", "summary": "List account children", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.getChildren", "description": "Get child accounts.\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [ { "deprecated": false, "description": null, "location": "query", "name": "onlyIds", "required": false, "schema": { "type": "boolean" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AccountListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs.", "truncated": true }, "name": { "type": "string", "description": "Name of this account.", "truncated": true }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true, "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts/{id}/children" } }, { "id": "admin.accounts.create", "method": "POST", "pathTemplate": "accounts", "stability": "stable", "summary": "Create an account", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.post", "description": "Create a new account.\nResource: organization\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs." }, "name": { "type": "string", "description": "Name of this account." }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "Account", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs." }, "name": { "type": "string", "description": "Name of this account." }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts" } }, { "id": "admin.accounts.delete", "method": "DELETE", "pathTemplate": "accounts/{accountId}", "stability": "stable", "summary": "Delete an account", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.delete", "description": "Delete an account.\nResource: organization\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts/{id}" } }, { "id": "admin.accounts.get", "method": "GET", "pathTemplate": "accounts/{accountId}", "stability": "stable", "summary": "Get an account", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.getOne", "description": "Get an existing account by account ID.\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs." }, "name": { "type": "string", "description": "Name of this account." }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts/{id}" } }, { "id": "admin.accounts.list", "method": "GET", "pathTemplate": "accounts", "stability": "stable", "summary": "List accounts", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.list", "description": "List all accounts in this Formant organization.\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AccountListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs.", "truncated": true }, "name": { "type": "string", "description": "Name of this account.", "truncated": true }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true, "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts/" } }, { "id": "admin.accounts.tree.get", "method": "GET", "pathTemplate": "accounts/{accountId}/tree", "stability": "stable", "summary": "Get an account tree", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.getAccountTree", "description": "Get account tree.\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs." }, "name": { "type": "string", "description": "Name of this account." }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts/{id}/tree" } }, { "id": "admin.accounts.update", "method": "PATCH", "pathTemplate": "accounts/{accountId}", "stability": "stable", "summary": "Update an account", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AccountController.patch", "description": "Update an existing account.\nResource: organization\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialAccount", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs." }, "name": { "type": "string", "description": "Name of this account." }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "PartialAccount", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Account", "type": "object", "required": [ "name", "parentId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this account belongs." }, "name": { "type": "string", "description": "Name of this account." }, "parentId": { "type": "string", "format": "uuid", "description": "ID of the parent account to this account.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/accounts/{id}" } }, { "id": "admin.annotation-templates.create", "method": "POST", "pathTemplate": "annotation-templates", "stability": "stable", "summary": "Create an annotation template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationTemplateController.post", "description": "Create a new annotation template.\nResource: annotations\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AnnotationTemplate", "type": "object", "required": [ "name", "fields" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this annotation template." }, "name": { "type": "string", "description": "Name of this annotation template." }, "description": { "type": "string", "description": "Description for this annotation template." }, "fields": { "type": "array", "description": "JSON object containing the fields for this annotation template.", "items": { "ref": "#/components/schemas/AnnotationField", "type": "object", "required": [ "type", "key", "name", "required", "parameters" ], "properties": { "type": { "type": "string", "enum": [ "tag", "sheet", "user" ] }, "key": { "type": "object" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "parameters": { "oneOf": [ { "ref": "#/components/schemas/TagParameters", "type": "object", "required": [ "choices" ], "truncated": true }, { "ref": "#/components/schemas/UserParameters", "type": "object", "truncated": true }, { "ref": "#/components/schemas/SheetParameters", "type": "object", "required": [ "spreadsheetId", "range" ], "truncated": true } ] } } } }, "publishToGoogleSpreadsheetUrl": { "type": "string", "format": "url", "description": "If you want to define your annotation template via Google Sheets, enter the URL to the sheet.", "nullable": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "AnnotationTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AnnotationTemplate", "type": "object", "required": [ "name", "fields" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this annotation template." }, "name": { "type": "string", "description": "Name of this annotation template." }, "description": { "type": "string", "description": "Description for this annotation template." }, "fields": { "type": "array", "description": "JSON object containing the fields for this annotation template.", "items": { "ref": "#/components/schemas/AnnotationField", "type": "object", "required": [ "type", "key", "name", "required", "parameters" ], "properties": { "type": { "type": "string", "enum": [ "tag", "sheet", "user" ], "truncated": true }, "key": { "type": "object", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true }, "required": { "type": "boolean", "truncated": true }, "parameters": { "type": "object", "truncated": true } } } }, "publishToGoogleSpreadsheetUrl": { "type": "string", "format": "url", "description": "If you want to define your annotation template via Google Sheets, enter the URL to the sheet.", "nullable": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotation-templates" } }, { "id": "admin.annotation-templates.delete", "method": "DELETE", "pathTemplate": "annotation-templates/{annotationTemplateId}", "stability": "stable", "summary": "Delete an annotation template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationTemplateController.delete", "description": "Delete an annotation template.\nResource: annotations\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotation-templates/{id}" } }, { "id": "admin.annotation-templates.get", "method": "GET", "pathTemplate": "annotation-templates/{annotationTemplateId}", "stability": "stable", "summary": "Get an annotation template by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationTemplateController.getOne", "description": "Get an existing annotation template.\nResource: annotations\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AnnotationTemplate", "type": "object", "required": [ "name", "fields" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this annotation template." }, "name": { "type": "string", "description": "Name of this annotation template." }, "description": { "type": "string", "description": "Description for this annotation template." }, "fields": { "type": "array", "description": "JSON object containing the fields for this annotation template.", "items": { "ref": "#/components/schemas/AnnotationField", "type": "object", "required": [ "type", "key", "name", "required", "parameters" ], "properties": { "type": { "type": "string", "enum": [ "tag", "sheet", "user" ], "truncated": true }, "key": { "type": "object", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true }, "required": { "type": "boolean", "truncated": true }, "parameters": { "type": "object", "truncated": true } } } }, "publishToGoogleSpreadsheetUrl": { "type": "string", "format": "url", "description": "If you want to define your annotation template via Google Sheets, enter the URL to the sheet.", "nullable": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotation-templates/{id}" } }, { "id": "admin.annotation-templates.inspect-spreadsheet", "method": "POST", "pathTemplate": "annotation-templates/inspect-spreadsheet", "stability": "stable", "summary": "Inspect annotation template spreadsheet", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationTemplateController.inspectSpreadsheet", "description": "Returns information about the Spreadsheet and its content\nResource: annotations\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InspectSpreadsheetRequest", "type": "object", "required": [ "spreadsheetUrl" ], "properties": { "spreadsheetUrl": { "type": "string", "format": "url" } } } } }, "contentTypes": [ "application/json" ], "description": "InspectSpreadsheetRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InspectSpreadsheetResponse", "type": "object", "required": [ "inspection" ], "properties": { "inspection": { "ref": "#/components/schemas/GoogleSpreadsheetInspection", "type": "object", "properties": { "parseUrlFailed": { "type": "boolean" }, "spreadsheetGetFailed": { "type": "boolean" }, "sheetFindFailed": { "type": "boolean" }, "sheetTitle": { "type": "string" }, "parseResult": { "ref": "#/components/schemas/GoogleSheetParseResult", "type": "object", "properties": { "headerInvalid": { "type": "boolean", "truncated": true }, "headerPreview": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "contentInvalid": { "type": "boolean", "truncated": true }, "values": { "type": "array", "items": { "ref": "#/components/schemas/AnnotationFieldValue", "type": "object", "required": [ "key", "value", "tags" ], "truncated": true }, "truncated": true } } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotation-templates/inspect-spreadsheet" } }, { "id": "admin.annotation-templates.list", "method": "GET", "pathTemplate": "annotation-templates", "stability": "stable", "summary": "List annotation templates", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationTemplateController.list", "description": "List annotation templates in your organization.\nResource: annotations\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AnnotationTemplateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/AnnotationTemplate", "type": "object", "required": [ "name", "fields" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this annotation template.", "truncated": true }, "name": { "type": "string", "description": "Name of this annotation template.", "truncated": true }, "description": { "type": "string", "description": "Description for this annotation template.", "truncated": true }, "fields": { "type": "array", "description": "JSON object containing the fields for this annotation template.", "items": { "ref": "#/components/schemas/AnnotationField", "type": "object", "required": [ "type", "key", "name", "required", "parameters" ], "truncated": true }, "truncated": true }, "publishToGoogleSpreadsheetUrl": { "type": "string", "format": "url", "description": "If you want to define your annotation template via Google Sheets, enter the URL to the sheet.", "nullable": true, "truncated": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotation-templates/" } }, { "id": "admin.annotation-templates.update", "method": "PATCH", "pathTemplate": "annotation-templates/{annotationTemplateId}", "stability": "stable", "summary": "Update an annotation template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationTemplateController.patch", "description": "Update an existing annotation template.\nResource: annotations\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialAnnotationTemplate", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this annotation template." }, "name": { "type": "string", "description": "Name of this annotation template." }, "description": { "type": "string", "description": "Description for this annotation template." }, "fields": { "type": "array", "description": "JSON object containing the fields for this annotation template.", "items": { "ref": "#/components/schemas/AnnotationField", "type": "object", "required": [ "type", "key", "name", "required", "parameters" ], "properties": { "type": { "type": "string", "enum": [ "tag", "sheet", "user" ] }, "key": { "type": "object" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "parameters": { "oneOf": [ { "ref": "#/components/schemas/TagParameters", "type": "object", "required": [ "choices" ], "truncated": true }, { "ref": "#/components/schemas/UserParameters", "type": "object", "truncated": true }, { "ref": "#/components/schemas/SheetParameters", "type": "object", "required": [ "spreadsheetId", "range" ], "truncated": true } ] } } } }, "publishToGoogleSpreadsheetUrl": { "type": "string", "format": "url", "description": "If you want to define your annotation template via Google Sheets, enter the URL to the sheet.", "nullable": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialAnnotationTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AnnotationTemplate", "type": "object", "required": [ "name", "fields" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this annotation template." }, "name": { "type": "string", "description": "Name of this annotation template." }, "description": { "type": "string", "description": "Description for this annotation template." }, "fields": { "type": "array", "description": "JSON object containing the fields for this annotation template.", "items": { "ref": "#/components/schemas/AnnotationField", "type": "object", "required": [ "type", "key", "name", "required", "parameters" ], "properties": { "type": { "type": "string", "enum": [ "tag", "sheet", "user" ], "truncated": true }, "key": { "type": "object", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true }, "required": { "type": "boolean", "truncated": true }, "parameters": { "type": "object", "truncated": true } } } }, "publishToGoogleSpreadsheetUrl": { "type": "string", "format": "url", "description": "If you want to define your annotation template via Google Sheets, enter the URL to the sheet.", "nullable": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotation-templates/{id}" } }, { "id": "admin.annotations.create", "method": "POST", "pathTemplate": "annotations", "stability": "stable", "summary": "Create an annotation", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationController.post", "description": "Create a new annotation.\nResource: annotations\nAuthorized roles: operator, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Annotation", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User associated with this annotation.", "nullable": true }, "annotationTemplateId": { "type": "string", "format": "uuid", "description": "If you want to create this annotation from an existing annotation template, enter its ID here.", "nullable": true }, "taggedUsers": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "publishedTo": { "type": "object" }, "note": { "type": "string", "description": "Description of this annotation.", "nullable": true }, "focusedDataPoints": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/FocusedDatapoint", "type": "object", "required": [ "streamName", "time" ], "properties": { "streamName": { "type": "string" }, "time": { "type": "string", "format": "date-time" } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "Annotation", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Annotation", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User associated with this annotation.", "nullable": true }, "annotationTemplateId": { "type": "string", "format": "uuid", "description": "If you want to create this annotation from an existing annotation template, enter its ID here.", "nullable": true }, "taggedUsers": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } }, "publishedTo": { "type": "object" }, "note": { "type": "string", "description": "Description of this annotation.", "nullable": true }, "focusedDataPoints": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/FocusedDatapoint", "type": "object", "required": [ "streamName", "time" ], "properties": { "streamName": { "type": "string", "truncated": true }, "time": { "type": "string", "format": "date-time", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotations" } }, { "id": "admin.annotations.delete", "method": "DELETE", "pathTemplate": "annotations/{annotationId}", "stability": "stable", "summary": "Delete an annotation", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationController.delete", "description": "Delete an annotation.\nResource: annotations\nAuthorized roles: operator, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotations/{id}" } }, { "id": "admin.annotations.get", "method": "GET", "pathTemplate": "annotations/{annotationId}", "stability": "stable", "summary": "Get an annotation", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationController.getOne", "description": "Get an existing annotation by annotation ID.\nResource: annotations\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Annotation", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User associated with this annotation.", "nullable": true }, "annotationTemplateId": { "type": "string", "format": "uuid", "description": "If you want to create this annotation from an existing annotation template, enter its ID here.", "nullable": true }, "taggedUsers": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } }, "publishedTo": { "type": "object" }, "note": { "type": "string", "description": "Description of this annotation.", "nullable": true }, "focusedDataPoints": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/FocusedDatapoint", "type": "object", "required": [ "streamName", "time" ], "properties": { "streamName": { "type": "string", "truncated": true }, "time": { "type": "string", "format": "date-time", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotations/{id}" } }, { "id": "admin.annotations.update", "method": "PATCH", "pathTemplate": "annotations/{annotationId}", "stability": "stable", "summary": "Update an annotation", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "AnnotationController.patch", "description": "Update an existing annotation.\nResource: annotations\nAuthorized roles: operator, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialAnnotation", "type": "object", "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User associated with this annotation.", "nullable": true }, "annotationTemplateId": { "type": "string", "format": "uuid", "description": "If you want to create this annotation from an existing annotation template, enter its ID here.", "nullable": true }, "taggedUsers": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "publishedTo": { "type": "object" }, "note": { "type": "string", "description": "Description of this annotation.", "nullable": true }, "focusedDataPoints": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/FocusedDatapoint", "type": "object", "required": [ "streamName", "time" ], "properties": { "streamName": { "type": "string" }, "time": { "type": "string", "format": "date-time" } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "PartialAnnotation", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Annotation", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User associated with this annotation.", "nullable": true }, "annotationTemplateId": { "type": "string", "format": "uuid", "description": "If you want to create this annotation from an existing annotation template, enter its ID here.", "nullable": true }, "taggedUsers": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } }, "publishedTo": { "type": "object" }, "note": { "type": "string", "description": "Description of this annotation.", "nullable": true }, "focusedDataPoints": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/FocusedDatapoint", "type": "object", "required": [ "streamName", "time" ], "properties": { "streamName": { "type": "string", "truncated": true }, "time": { "type": "string", "format": "date-time", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/annotations/{id}" } }, { "id": "admin.channels.create", "method": "POST", "pathTemplate": "channels", "stability": "stable", "summary": "Create a channel", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ChannelController.post", "description": "Create a channel\nResource: channels\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Channel", "type": "object", "required": [ "name", "filter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "layout": { "type": "object" }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string" }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "configuration": { "oneOf": [ { "ref": "#/components/schemas/BitsetViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/ImageViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocalizationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/PointCloudViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/TransformTreeViewConfiguration", "type": "object", "truncated": true } ] } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Channel", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Channel", "type": "object", "required": [ "name", "filter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "layout": { "type": "object" }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "configuration": { "type": "object", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/channels" } }, { "id": "admin.channels.delete", "method": "DELETE", "pathTemplate": "channels/{channelId}", "stability": "stable", "summary": "Delete a channel", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ChannelController.delete", "description": "Delete a channel\nResource: channels\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/channels/{id}" } }, { "id": "admin.channels.get", "method": "GET", "pathTemplate": "channels/{channelId}", "stability": "stable", "summary": "Get a channel by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ChannelController.getOne", "description": "Get a channel\nResource: channels\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Channel", "type": "object", "required": [ "name", "filter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "layout": { "type": "object" }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "configuration": { "type": "object", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/channels/{id}" } }, { "id": "admin.channels.list", "method": "GET", "pathTemplate": "channels", "stability": "stable", "summary": "List channels", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ChannelController.getAll", "description": "List all channels\nResource: channels\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ChannelListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Channel", "type": "object", "required": [ "name", "filter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "truncated": true }, "layout": { "type": "object", "truncated": true }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "truncated": true }, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/channels" } }, { "id": "admin.channels.update", "method": "PATCH", "pathTemplate": "channels/{channelId}", "stability": "stable", "summary": "Update a channel", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ChannelController.patch", "description": "Update a channel\nResource: channels\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialChannel", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "layout": { "type": "object" }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string" }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "configuration": { "oneOf": [ { "ref": "#/components/schemas/BitsetViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/ImageViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocalizationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/PointCloudViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/TransformTreeViewConfiguration", "type": "object", "truncated": true } ] } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "PartialChannel", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Channel", "type": "object", "required": [ "name", "filter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "layout": { "type": "object" }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "configuration": { "type": "object", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/channels/{id}" } }, { "id": "admin.command-templates.create", "method": "POST", "pathTemplate": "command-templates", "stability": "stable", "summary": "Create a command template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandTemplateController.post", "description": "Create a new command template.\nResource: commands\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandTemplate", "type": "object", "required": [ "name", "command", "parameterEnabled", "deviceFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template." }, "name": { "type": "string", "description": "Name of this command template." }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template." }, "description": { "type": "string", "description": "Description of this command template." }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`." }, "allowParameterOverride": { "type": "boolean" }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent." }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted." }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "lambdaUri": { "type": "string", "nullable": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "properties": { "ttlMs": { "type": "integer", "format": "int64" }, "retryable": { "type": "boolean" } } }, "schema": { "type": "string", "format": "json", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "CommandTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandTemplate", "type": "object", "required": [ "name", "command", "parameterEnabled", "deviceFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template." }, "name": { "type": "string", "description": "Name of this command template." }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template." }, "description": { "type": "string", "description": "Description of this command template." }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`." }, "allowParameterOverride": { "type": "boolean" }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent." }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted." }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "lambdaUri": { "type": "string", "nullable": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "properties": { "ttlMs": { "type": "integer", "format": "int64" }, "retryable": { "type": "boolean" } } }, "schema": { "type": "string", "format": "json", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/command-templates" } }, { "id": "admin.command-templates.delete", "method": "DELETE", "pathTemplate": "command-templates/{commandTemplateId}", "stability": "stable", "summary": "Delete a command template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandTemplateController.delete", "description": "Delete a command template.\nResource: commands\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/command-templates/{id}" } }, { "id": "admin.command-templates.get", "method": "GET", "pathTemplate": "command-templates/{commandTemplateId}", "stability": "stable", "summary": "Get a command template by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandTemplateController.getOne", "description": "Get a command template by command template ID.\nResource: commands\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandTemplate", "type": "object", "required": [ "name", "command", "parameterEnabled", "deviceFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template." }, "name": { "type": "string", "description": "Name of this command template." }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template." }, "description": { "type": "string", "description": "Description of this command template." }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`." }, "allowParameterOverride": { "type": "boolean" }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent." }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted." }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "lambdaUri": { "type": "string", "nullable": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "properties": { "ttlMs": { "type": "integer", "format": "int64" }, "retryable": { "type": "boolean" } } }, "schema": { "type": "string", "format": "json", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/command-templates/{id}" } }, { "id": "admin.command-templates.list", "method": "GET", "pathTemplate": "command-templates", "stability": "stable", "summary": "List command templates", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandTemplateController.list", "description": "List command templates in your organization.\nResource: commands\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandTemplateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/CommandTemplate", "type": "object", "required": [ "name", "command", "parameterEnabled", "deviceFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template.", "truncated": true }, "name": { "type": "string", "description": "Name of this command template.", "truncated": true }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template.", "truncated": true }, "description": { "type": "string", "description": "Description of this command template.", "truncated": true }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`.", "truncated": true }, "allowParameterOverride": { "type": "boolean", "truncated": true }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent.", "truncated": true }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "truncated": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "truncated": true }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted.", "truncated": true }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "truncated": true }, "lambdaUri": { "type": "string", "nullable": true, "truncated": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "truncated": true }, "schema": { "type": "string", "format": "json", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/command-templates/" } }, { "id": "admin.command-templates.update", "method": "PATCH", "pathTemplate": "command-templates/{commandTemplateId}", "stability": "stable", "summary": "Update a command template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandTemplateController.patch", "description": "Update an existing command template.\nResource: commands\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialCommandTemplate", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template." }, "name": { "type": "string", "description": "Name of this command template." }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template." }, "description": { "type": "string", "description": "Description of this command template." }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`." }, "allowParameterOverride": { "type": "boolean" }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent." }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted." }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "lambdaUri": { "type": "string", "nullable": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "properties": { "ttlMs": { "type": "integer", "format": "int64" }, "retryable": { "type": "boolean" } } }, "schema": { "type": "string", "format": "json", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialCommandTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandTemplate", "type": "object", "required": [ "name", "command", "parameterEnabled", "deviceFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template." }, "name": { "type": "string", "description": "Name of this command template." }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template." }, "description": { "type": "string", "description": "Description of this command template." }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`." }, "allowParameterOverride": { "type": "boolean" }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent." }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted." }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "lambdaUri": { "type": "string", "nullable": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "properties": { "ttlMs": { "type": "integer", "format": "int64" }, "retryable": { "type": "boolean" } } }, "schema": { "type": "string", "format": "json", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/command-templates/{id}" } }, { "id": "admin.commands.create", "method": "POST", "pathTemplate": "commands", "stability": "stable", "summary": "Create and send a command", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandController.post", "description": "Create a new command instance.\nResource: commands\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Command", "type": "object", "required": [ "deviceId", "command", "parameter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create this new command instance." }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device on which this command should run." }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user who issued this command.", "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "eventTriggerId": { "type": "string", "format": "uuid", "description": "Used by Formant agent only, ignore." }, "command": { "type": "string", "description": "Function, script, or routine to execute." }, "parameter": { "ref": "#/components/schemas/CommandParameter", "type": "object", "required": [ "scrubberTime" ], "properties": { "value": { "type": "string", "description": "Enter your parameter and value. This string will be passed along with your command." }, "meta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string" } }, "scrubberTime": { "type": "string", "format": "date-time", "description": "Timestamp associated with this command." }, "files": { "type": "array", "description": "File(s) to be sent as a parameter with your command. Up to five files allowed.", "items": { "ref": "#/components/schemas/FileInfo", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "url": { "type": "string", "format": "url", "truncated": true } } } } } }, "deliveredAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true }, "canceledAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true }, "respondedAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true }, "success": { "type": "boolean", "description": "Used by Formant agent only, ignore.", "nullable": true }, "streamName": { "type": "string", "description": "Used by Formant agent only, ignore.", "nullable": true }, "streamType": { "type": "string", "description": "Used by Formant agent only, ignore.", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "tags": { "type": "object", "description": "Tags associated with this command instance.", "nullable": true, "additionalProperties": { "type": "string" } }, "lambdaUri": { "type": "string", "nullable": true }, "expiredAt": { "type": "string", "format": "date-time", "nullable": true }, "retryable": { "type": "boolean", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Command", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Command", "type": "object", "required": [ "deviceId", "command", "parameter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create this new command instance." }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device on which this command should run." }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user who issued this command.", "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "eventTriggerId": { "type": "string", "format": "uuid", "description": "Used by Formant agent only, ignore." }, "command": { "type": "string", "description": "Function, script, or routine to execute." }, "parameter": { "ref": "#/components/schemas/CommandParameter", "type": "object", "required": [ "scrubberTime" ], "properties": { "value": { "type": "string", "description": "Enter your parameter and value. This string will be passed along with your command." }, "meta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "additionalProperties": { "type": "string", "truncated": true } }, "scrubberTime": { "type": "string", "format": "date-time", "description": "Timestamp associated with this command." }, "files": { "type": "array", "description": "File(s) to be sent as a parameter with your command. Up to five files allowed.", "items": { "ref": "#/components/schemas/FileInfo", "type": "object", "required": [ "id" ], "truncated": true } } } }, "deliveredAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true }, "canceledAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true }, "respondedAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true }, "success": { "type": "boolean", "description": "Used by Formant agent only, ignore.", "nullable": true }, "streamName": { "type": "string", "description": "Used by Formant agent only, ignore.", "nullable": true }, "streamType": { "type": "string", "description": "Used by Formant agent only, ignore.", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "tags": { "type": "object", "description": "Tags associated with this command instance.", "nullable": true, "additionalProperties": { "type": "string" } }, "lambdaUri": { "type": "string", "nullable": true }, "expiredAt": { "type": "string", "format": "date-time", "nullable": true }, "retryable": { "type": "boolean", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/commands" } }, { "id": "admin.commands.query", "method": "POST", "pathTemplate": "commands/query", "stability": "stable", "summary": "Query commands", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommandController.query", "description": "Query undelivered commands.\nResource: commands\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandQuery", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "deviceId": { "type": "string", "format": "uuid" }, "createdAfter": { "type": "string", "format": "date-time" }, "limit": { "type": "integer", "format": "int64" }, "destination": { "type": "string", "enum": [ "agent", "cloud" ] }, "next": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": "CommandQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Command", "type": "object", "required": [ "deviceId", "command", "parameter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create this new command instance.", "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device on which this command should run.", "truncated": true }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user who issued this command.", "nullable": true, "truncated": true }, "commandTemplateId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventTriggerId": { "type": "string", "format": "uuid", "description": "Used by Formant agent only, ignore.", "truncated": true }, "command": { "type": "string", "description": "Function, script, or routine to execute.", "truncated": true }, "parameter": { "ref": "#/components/schemas/CommandParameter", "type": "object", "required": [ "scrubberTime" ], "truncated": true }, "deliveredAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true, "truncated": true }, "canceledAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true, "truncated": true }, "respondedAt": { "type": "string", "format": "date-time", "description": "Used by Formant agent only, ignore.", "nullable": true, "truncated": true }, "success": { "type": "boolean", "description": "Used by Formant agent only, ignore.", "nullable": true, "truncated": true }, "streamName": { "type": "string", "description": "Used by Formant agent only, ignore.", "nullable": true, "truncated": true }, "streamType": { "type": "string", "description": "Used by Formant agent only, ignore.", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "tags": { "type": "object", "description": "Tags associated with this command instance.", "nullable": true, "truncated": true }, "lambdaUri": { "type": "string", "nullable": true, "truncated": true }, "expiredAt": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "retryable": { "type": "boolean", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } }, "next": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/commands/query" } }, { "id": "admin.comments.create", "method": "POST", "pathTemplate": "comments", "stability": "stable", "summary": "Create a comment", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommentController.post", "description": "Create a comment\nResource: comments\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Comment", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "Comment", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Comment", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/comments" } }, { "id": "admin.comments.delete", "method": "DELETE", "pathTemplate": "comments/{commentId}", "stability": "stable", "summary": "Delete a comment", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommentController.delete", "description": "Delete a comment\nResource: comments\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/comments/{id}" } }, { "id": "admin.comments.get", "method": "GET", "pathTemplate": "comments/{commentId}", "stability": "stable", "summary": "Get a comment", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommentController.getOne", "description": "Get a comment\nResource: comments\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Comment", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/comments/{id}" } }, { "id": "admin.comments.update", "method": "PATCH", "pathTemplate": "comments/{commentId}", "stability": "stable", "summary": "Update a comment", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "CommentController.patch", "description": "Update a comment\nResource: comments\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialComment", "type": "object", "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "PartialComment", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Comment", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "editedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/comments/{id}" } }, { "id": "admin.device-configuration-templates.create", "method": "POST", "pathTemplate": "device-configuration-templates", "stability": "stable", "summary": "Create a device configuration template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceConfigurationTemplateController.post", "description": "Create a device configuration template\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfigurationTemplate", "type": "object", "required": [ "name", "document" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "properties": { "bufferSize": { "type": "integer", "format": "int64", "truncated": true }, "onDemandBufferSize": { "type": "integer", "format": "int64", "truncated": true } } }, "streamThrottleHz": { "type": "number", "nullable": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true } }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "properties": { "worldReferenceFrameId": { "type": "string", "deprecated": true, "truncated": true } } } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true } }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true } }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true } } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string" } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true } }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true } }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true } }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "properties": { "position": { "type": "string", "enum": [ "left", "right" ], "truncated": true }, "disableTriggerJoystickMapping": { "type": "boolean", "truncated": true }, "disableGamepadAndKeyboard": { "type": "boolean", "truncated": true }, "sameValueDebounce": { "type": "number", "truncated": true }, "newValueDebounce": { "type": "number", "truncated": true }, "x": { "ref": "#/components/schemas/TeleopJoystickAxisConfiguration", "type": "object", "truncated": true }, "y": { "ref": "#/components/schemas/TeleopJoystickAxisConfiguration", "type": "object", "truncated": true }, "velocityStreamName": { "type": "string", "truncated": true } }, "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true } }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "properties": { "streamName": { "type": "object", "truncated": true }, "configurationId": { "type": "object", "truncated": true } }, "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true } }, "armSwitch": { "type": "boolean" }, "allowLowBandwidthMode": { "type": "boolean" }, "disableHighPingWarning": { "type": "boolean" } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true }, "ingestLogs": { "type": "boolean", "nullable": true }, "reportMetrics": { "type": "boolean", "nullable": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "fileId": { "type": "string", "format": "uuid", "truncated": true }, "execCommand": { "type": "string", "truncated": true }, "configuration": { "type": "string", "truncated": true } } } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true } }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ] }, "useAllServers": { "type": "boolean" } } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceConfigurationTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfigurationTemplate", "type": "object", "required": [ "name", "document" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "truncated": true }, "streamThrottleHz": { "type": "number", "nullable": true, "truncated": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true, "truncated": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true }, "truncated": true }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "truncated": true } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "truncated": true } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string", "truncated": true } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true }, "truncated": true }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true }, "truncated": true }, "armSwitch": { "type": "boolean", "truncated": true }, "allowLowBandwidthMode": { "type": "boolean", "truncated": true }, "disableHighPingWarning": { "type": "boolean", "truncated": true } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true, "truncated": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true, "truncated": true }, "ingestLogs": { "type": "boolean", "nullable": true, "truncated": true }, "reportMetrics": { "type": "boolean", "nullable": true, "truncated": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "truncated": true } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true }, "truncated": true }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ], "truncated": true }, "useAllServers": { "type": "boolean", "truncated": true } } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-configuration-templates" } }, { "id": "admin.device-configuration-templates.delete", "method": "DELETE", "pathTemplate": "device-configuration-templates/{templateId}", "stability": "stable", "summary": "Delete a device configuration template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceConfigurationTemplateController.delete", "description": "Delete a device configuration template\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-configuration-templates/{id}" } }, { "id": "admin.device-configuration-templates.get", "method": "GET", "pathTemplate": "device-configuration-templates/{templateId}", "stability": "stable", "summary": "Get a device configuration template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceConfigurationTemplateController.getOne", "description": "Get a device configuration template\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfigurationTemplate", "type": "object", "required": [ "name", "document" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "truncated": true }, "streamThrottleHz": { "type": "number", "nullable": true, "truncated": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true, "truncated": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true }, "truncated": true }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "truncated": true } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "truncated": true } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string", "truncated": true } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true }, "truncated": true }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true }, "truncated": true }, "armSwitch": { "type": "boolean", "truncated": true }, "allowLowBandwidthMode": { "type": "boolean", "truncated": true }, "disableHighPingWarning": { "type": "boolean", "truncated": true } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true, "truncated": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true, "truncated": true }, "ingestLogs": { "type": "boolean", "nullable": true, "truncated": true }, "reportMetrics": { "type": "boolean", "nullable": true, "truncated": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "truncated": true } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true }, "truncated": true }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ], "truncated": true }, "useAllServers": { "type": "boolean", "truncated": true } } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-configuration-templates/{id}" } }, { "id": "admin.device-configuration-templates.list", "method": "GET", "pathTemplate": "device-configuration-templates", "stability": "stable", "summary": "List device configuration templates", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceConfigurationTemplateController.list", "description": "List device configuration templates\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfigurationTemplateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/DeviceConfigurationTemplate", "type": "object", "required": [ "name", "document" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-configuration-templates/" } }, { "id": "admin.device-configuration-templates.update", "method": "PATCH", "pathTemplate": "device-configuration-templates/{templateId}", "stability": "stable", "summary": "Update a device configuration template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceConfigurationTemplateController.patch", "description": "Update a device configuration template\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialDeviceConfigurationTemplate", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "properties": { "bufferSize": { "type": "integer", "format": "int64", "truncated": true }, "onDemandBufferSize": { "type": "integer", "format": "int64", "truncated": true } } }, "streamThrottleHz": { "type": "number", "nullable": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true } }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "properties": { "worldReferenceFrameId": { "type": "string", "deprecated": true, "truncated": true } } } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true } }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true } }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true } } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string" } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true } }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true } }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true } }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "properties": { "position": { "type": "string", "enum": [ "left", "right" ], "truncated": true }, "disableTriggerJoystickMapping": { "type": "boolean", "truncated": true }, "disableGamepadAndKeyboard": { "type": "boolean", "truncated": true }, "sameValueDebounce": { "type": "number", "truncated": true }, "newValueDebounce": { "type": "number", "truncated": true }, "x": { "ref": "#/components/schemas/TeleopJoystickAxisConfiguration", "type": "object", "truncated": true }, "y": { "ref": "#/components/schemas/TeleopJoystickAxisConfiguration", "type": "object", "truncated": true }, "velocityStreamName": { "type": "string", "truncated": true } }, "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true } }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "properties": { "streamName": { "type": "object", "truncated": true }, "configurationId": { "type": "object", "truncated": true } }, "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true } }, "armSwitch": { "type": "boolean" }, "allowLowBandwidthMode": { "type": "boolean" }, "disableHighPingWarning": { "type": "boolean" } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true }, "ingestLogs": { "type": "boolean", "nullable": true }, "reportMetrics": { "type": "boolean", "nullable": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "fileId": { "type": "string", "format": "uuid", "truncated": true }, "execCommand": { "type": "string", "truncated": true }, "configuration": { "type": "string", "truncated": true } } } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true } }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ] }, "useAllServers": { "type": "boolean" } } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialDeviceConfigurationTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfigurationTemplate", "type": "object", "required": [ "name", "document" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "truncated": true }, "streamThrottleHz": { "type": "number", "nullable": true, "truncated": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true, "truncated": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true }, "truncated": true }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "truncated": true } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "truncated": true } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string", "truncated": true } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true }, "truncated": true }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true }, "truncated": true }, "armSwitch": { "type": "boolean", "truncated": true }, "allowLowBandwidthMode": { "type": "boolean", "truncated": true }, "disableHighPingWarning": { "type": "boolean", "truncated": true } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true, "truncated": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true, "truncated": true }, "ingestLogs": { "type": "boolean", "nullable": true, "truncated": true }, "reportMetrics": { "type": "boolean", "nullable": true, "truncated": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "truncated": true } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true }, "truncated": true }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ], "truncated": true }, "useAllServers": { "type": "boolean", "truncated": true } } } } }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-configuration-templates/{id}" } }, { "id": "admin.device-details.get", "method": "GET", "pathTemplate": "device-details/{deviceId}", "stability": "stable", "summary": "Get device details", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceDetailsController.getOne", "description": "Get device details by device ID.\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [ { "deprecated": false, "description": null, "location": "query", "name": "fillLastSeen", "required": false, "schema": { "type": "boolean" } }, { "deprecated": false, "description": null, "location": "query", "name": "fillOnlineStatus", "required": false, "schema": { "type": "boolean" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceDetails", "type": "object", "required": [ "createdAt", "updatedAt", "id", "name", "type", "tags", "enabled", "publicKey", "description", "online", "lastSeen", "agentVersion", "disabledAt" ], "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "default", "capture" ] }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" }, "publicKey": { "type": "string" }, "online": { "type": "boolean", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "agentVersion": { "type": "string", "nullable": true }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-details/{id}" } }, { "id": "admin.device-details.query", "method": "POST", "pathTemplate": "device-details/query", "stability": "stable", "summary": "Query device details", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceDetailsController.getAll", "description": "Get device details by querying devices.\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceQuery", "type": "object", "properties": { "deviceIds": { "type": "array", "description": "Query devices by device ID.", "items": { "type": "string", "format": "uuid" } }, "externalId": { "type": "string", "description": "Query devices by external ID." }, "name": { "type": "string", "description": "Query devices by name." }, "query": { "type": "string", "description": "Query partial device names (case-insensitive)." }, "organizationId": { "type": "string", "description": "Query devices by organization ID." }, "tags": { "description": "Query devices by tags.", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "fleetId": { "type": "string", "format": "uuid", "description": "Query devices by fleet ID.", "nullable": true }, "enabled": { "type": "boolean", "description": "Query devices by enabled status." }, "fullyConfigured": { "type": "boolean", "description": "Query devices by configured status." }, "type": { "type": "string", "description": "Query devices by device type.", "enum": [ "default", "capture" ] }, "count": { "type": "number", "format": "int64", "description": "Limit the number of devices returned by this query (max 1000)." }, "offset": { "type": "number", "format": "int64", "description": "Paginate the results by specifying an offset." }, "createdAfter": { "type": "string", "format": "date-time", "description": "Query devices created after this date." }, "disabledBefore": { "type": "string", "format": "date-time", "description": "Query devices disabled (deleted) before this date." }, "online": { "type": "boolean", "description": "Query online devices." }, "fillOnlineStatus": { "type": "boolean", "description": "Include device online status in the response." }, "fillLastSeen": { "type": "boolean", "description": "Include last seen timestamp in the response." }, "sort": { "type": "array", "description": "Sort order for the query results.", "items": { "ref": "#/components/schemas/DeviceDetailsSort", "type": "object", "required": [ "column", "order" ], "properties": { "column": { "type": "string", "enum": [ "id", "name", "type", "tags", "enabled", "created_at" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] } } } }, "hasExternalId": { "type": "boolean", "description": "Query devices that have an externalId." } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceDetailsListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/DeviceDetails", "type": "object", "required": [ "createdAt", "updatedAt", "id", "name", "type", "tags", "enabled", "publicKey", "description", "online", "lastSeen", "agentVersion", "disabledAt" ], "properties": { "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "type": { "type": "string", "enum": [ "default", "capture" ], "truncated": true }, "tags": { "type": "object", "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "publicKey": { "type": "string", "truncated": true }, "online": { "type": "boolean", "nullable": true, "truncated": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "agentVersion": { "type": "string", "nullable": true, "truncated": true }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "externalId": { "type": "string", "nullable": true, "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/device-details/query" } }, { "id": "admin.devices.commands.list", "method": "GET", "pathTemplate": "devices/{deviceId}/commands", "stability": "stable", "summary": "List command templates available for a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.getCommands", "description": "List device commands\nResource: commands\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CommandTemplateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/CommandTemplate", "type": "object", "required": [ "name", "command", "parameterEnabled", "deviceFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID for the organization in which you want to create this new command template.", "truncated": true }, "name": { "type": "string", "description": "Name of this command template.", "truncated": true }, "command": { "type": "string", "description": "Function, script, or routine that will be executed by a command in this template.", "truncated": true }, "description": { "type": "string", "description": "Description of this command template.", "truncated": true }, "parameterEnabled": { "type": "boolean", "description": "If you want to send parameters with your command, set this to `true`.", "truncated": true }, "allowParameterOverride": { "type": "boolean", "truncated": true }, "parameterValue": { "type": "string", "description": "This string will be passed as a parameter when this command is sent.", "truncated": true }, "parameterMeta": { "type": "object", "description": "You can use this to add many parameters in a more structured way.", "truncated": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "truncated": true }, "enabled": { "type": "boolean", "description": "If set to `false`, this command template will be deleted.", "truncated": true }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "truncated": true }, "lambdaUri": { "type": "string", "nullable": true, "truncated": true }, "deliverySettings": { "ref": "#/components/schemas/CommandDeliverySettings", "type": "object", "truncated": true }, "schema": { "type": "string", "format": "json", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/commands" } }, { "id": "admin.devices.configuration.update", "method": "PUT", "pathTemplate": "devices/{deviceId}/configuration", "stability": "stable", "summary": "Update a device configuration", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.putConfiguration", "description": "Update a device's configuration.\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfiguration", "type": "object", "nullable": true, "required": [ "document" ], "properties": { "deviceId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int64" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "properties": { "bufferSize": { "type": "integer", "format": "int64", "truncated": true }, "onDemandBufferSize": { "type": "integer", "format": "int64", "truncated": true } } }, "streamThrottleHz": { "type": "number", "nullable": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true } }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "properties": { "worldReferenceFrameId": { "type": "string", "deprecated": true, "truncated": true } } } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true } }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true } }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true } } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string" } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true } }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true } }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true } }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "properties": { "position": { "type": "string", "enum": [ "left", "right" ], "truncated": true }, "disableTriggerJoystickMapping": { "type": "boolean", "truncated": true }, "disableGamepadAndKeyboard": { "type": "boolean", "truncated": true }, "sameValueDebounce": { "type": "number", "truncated": true }, "newValueDebounce": { "type": "number", "truncated": true }, "x": { "ref": "#/components/schemas/TeleopJoystickAxisConfiguration", "type": "object", "truncated": true }, "y": { "ref": "#/components/schemas/TeleopJoystickAxisConfiguration", "type": "object", "truncated": true }, "velocityStreamName": { "type": "string", "truncated": true } }, "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true } }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "properties": { "streamName": { "type": "object", "truncated": true }, "configurationId": { "type": "object", "truncated": true } }, "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true } }, "armSwitch": { "type": "boolean" }, "allowLowBandwidthMode": { "type": "boolean" }, "disableHighPingWarning": { "type": "boolean" } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true }, "ingestLogs": { "type": "boolean", "nullable": true }, "reportMetrics": { "type": "boolean", "nullable": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "fileId": { "type": "string", "format": "uuid", "truncated": true }, "execCommand": { "type": "string", "truncated": true }, "configuration": { "type": "string", "truncated": true } } } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true } }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ] }, "useAllServers": { "type": "boolean" } } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceConfiguration", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfiguration", "type": "object", "nullable": true, "required": [ "document" ], "properties": { "deviceId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int64" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "truncated": true }, "streamThrottleHz": { "type": "number", "nullable": true, "truncated": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true, "truncated": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true }, "truncated": true }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "truncated": true } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "truncated": true } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string", "truncated": true } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true }, "truncated": true }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true }, "truncated": true }, "armSwitch": { "type": "boolean", "truncated": true }, "allowLowBandwidthMode": { "type": "boolean", "truncated": true }, "disableHighPingWarning": { "type": "boolean", "truncated": true } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true, "truncated": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true, "truncated": true }, "ingestLogs": { "type": "boolean", "nullable": true, "truncated": true }, "reportMetrics": { "type": "boolean", "nullable": true, "truncated": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "truncated": true } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true }, "truncated": true }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ], "truncated": true }, "useAllServers": { "type": "boolean", "truncated": true } } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/configuration" } }, { "id": "admin.devices.configurations.getByVersion", "method": "GET", "pathTemplate": "devices/{deviceId}/configurations/{configurationVersion}", "stability": "stable", "summary": "Get a device configuration version", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.getConfiguration", "description": "Get a device configuration\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "deprecated": false, "description": null, "location": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceConfiguration", "type": "object", "nullable": true, "required": [ "document" ], "properties": { "deviceId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int64" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "properties": { "disk": { "ref": "#/components/schemas/DeviceDiskConfiguration", "type": "object", "truncated": true }, "streamThrottleHz": { "type": "number", "nullable": true, "truncated": true }, "lowBandwidthAgent": { "type": "boolean", "nullable": true, "truncated": true }, "datapointBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "datapointBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchSize": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "assetBatchLifetimeMs": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "properties": { "streams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "truncated": true }, "truncated": true }, "ros": { "ref": "#/components/schemas/DeviceRosConfiguration", "type": "object", "truncated": true } } }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true } } }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "properties": { "configurationMap": { "type": "object", "truncated": true } } }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string", "truncated": true } } }, "terminalAccess": { "type": "boolean", "nullable": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "properties": { "rosStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopRosStreamConfiguration", "type": "object", "required": [ "topicName", "topicType", "mode", "rosVersion" ], "truncated": true }, "truncated": true }, "customStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopCustomStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode" ], "truncated": true }, "truncated": true }, "hardwareStreams": { "type": "array", "items": { "ref": "#/components/schemas/DeviceTeleopHardwareStreamConfiguration", "type": "object", "required": [ "name", "rtcStreamType", "mode", "hwDescriptor", "hardwareType", "quality" ], "truncated": true }, "truncated": true }, "joysticks": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopJoystickConfiguration", "recursive": true }, "truncated": true }, "views": { "ref": "#/components/schemas/TeleopViewConfiguration", "type": "array", "items": { "ref": "#/components/schemas/TeleopViewConfiguration", "recursive": true }, "truncated": true }, "armSwitch": { "type": "boolean", "truncated": true }, "allowLowBandwidthMode": { "type": "boolean", "truncated": true }, "disableHighPingWarning": { "type": "boolean", "truncated": true } } }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true, "truncated": true } } }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "properties": { "reportLogs": { "type": "boolean", "nullable": true, "truncated": true }, "ingestLogs": { "type": "boolean", "nullable": true, "truncated": true }, "reportMetrics": { "type": "boolean", "nullable": true, "truncated": true } } }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "truncated": true } }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "properties": { "rtcIceTransportPolicies": { "type": "array", "items": { "type": "string", "enum": [ "stun", "turn" ], "truncated": true }, "truncated": true }, "rtcIceServerProtocol": { "type": "string", "enum": [ "udp", "tcp" ], "truncated": true }, "useAllServers": { "type": "boolean", "truncated": true } } } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/configurations/{version}" } }, { "id": "admin.devices.count", "method": "POST", "pathTemplate": "devices/count", "stability": "stable", "summary": "Count devices", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.count", "description": "Count devices\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceQuery", "type": "object", "properties": { "deviceIds": { "type": "array", "description": "Query devices by device ID.", "items": { "type": "string", "format": "uuid" } }, "externalId": { "type": "string", "description": "Query devices by external ID." }, "name": { "type": "string", "description": "Query devices by name." }, "query": { "type": "string", "description": "Query partial device names (case-insensitive)." }, "organizationId": { "type": "string", "description": "Query devices by organization ID." }, "tags": { "description": "Query devices by tags.", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "fleetId": { "type": "string", "format": "uuid", "description": "Query devices by fleet ID.", "nullable": true }, "enabled": { "type": "boolean", "description": "Query devices by enabled status." }, "fullyConfigured": { "type": "boolean", "description": "Query devices by configured status." }, "type": { "type": "string", "description": "Query devices by device type.", "enum": [ "default", "capture" ] }, "count": { "type": "number", "format": "int64", "description": "Limit the number of devices returned by this query (max 1000)." }, "offset": { "type": "number", "format": "int64", "description": "Paginate the results by specifying an offset." }, "createdAfter": { "type": "string", "format": "date-time", "description": "Query devices created after this date." }, "disabledBefore": { "type": "string", "format": "date-time", "description": "Query devices disabled (deleted) before this date." }, "online": { "type": "boolean", "description": "Query online devices." }, "fillOnlineStatus": { "type": "boolean", "description": "Include device online status in the response." }, "fillLastSeen": { "type": "boolean", "description": "Include last seen timestamp in the response." }, "sort": { "type": "array", "description": "Sort order for the query results.", "items": { "ref": "#/components/schemas/DeviceDetailsSort", "type": "object", "required": [ "column", "order" ], "properties": { "column": { "type": "string", "enum": [ "id", "name", "type", "tags", "enabled", "created_at" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] } } } }, "hasExternalId": { "type": "boolean", "description": "Query devices that have an externalId." } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/count" } }, { "id": "admin.devices.create", "method": "POST", "pathTemplate": "devices", "stability": "stable", "summary": "Create a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.post", "description": "Create a new device.\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Device", "type": "object", "required": [ "name" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization which contains this device." }, "externalId": { "type": "string", "description": "External ID of this device.", "nullable": true }, "name": { "type": "string", "description": "Name of this device." }, "description": { "type": "string", "description": "Description of this device.", "nullable": true }, "type": { "type": "string", "description": "Enter `default`.", "enum": [ "default", "capture" ] }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user associated with this device.", "nullable": true }, "fleetId": { "type": "string", "format": "uuid", "description": "ID of the fleet with which this device is associated.", "nullable": true }, "publicKey": { "type": "string" }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "deviceScope": { "ref": "#/components/schemas/DeviceScope", "type": "object", "description": "Currently unused, ignore.", "properties": { "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "commands": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "desiredAgentVersion": { "type": "string", "description": "Agent version you want to install if different from the latest version. Must have `formant-sidecar` installed.", "nullable": true }, "desiredConfigurationVersion": { "type": "integer", "format": "int64", "description": "Device configuration version you want to apply. Ignore for new device configuration.", "nullable": true }, "temporaryConfigurationVersion": { "type": "integer", "format": "int64", "nullable": true }, "temporaryConfigurationExpiration": { "type": "string", "format": "date-time", "nullable": true }, "temporaryConfigurationTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "muted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this device.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "followers": { "type": "array", "description": "Users who receive SMS updates from this device.", "items": { "ref": "#/components/schemas/DeviceFollower", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid" } } } }, "slackChannels": { "type": "array", "description": "Slack channels which receive updates from this device.", "items": { "type": "string" } }, "state": { "ref": "#/components/schemas/DeviceState", "type": "object", "properties": { "agentVersion": { "type": "string", "nullable": true }, "reportedConfiguration": { "ref": "#/components/schemas/DeviceReportedConfigurationState", "type": "object", "nullable": true, "required": [ "version" ], "properties": { "version": { "type": "integer", "format": "int64", "nullable": true } } }, "hwInfo": { "ref": "#/components/schemas/HwInfo", "type": "object", "nullable": true, "properties": { "kernelInfo": { "ref": "#/components/schemas/KernelInfo", "type": "object", "properties": { "version": { "type": "string", "truncated": true }, "release": { "type": "string", "truncated": true }, "architecture": { "type": "string", "truncated": true } } }, "osInfo": { "ref": "#/components/schemas/OsInfo", "type": "object", "properties": { "name": { "type": "string", "truncated": true }, "vendor": { "type": "string", "truncated": true }, "release": { "type": "string", "truncated": true }, "version": { "type": "string", "truncated": true } } }, "nodeInfo": { "ref": "#/components/schemas/NodeInfo", "type": "object", "properties": { "hostname": { "type": "string", "truncated": true }, "machineid": { "type": "string", "truncated": true }, "timezone": { "type": "string", "truncated": true } } }, "networkInfo": { "ref": "#/components/schemas/NetworkInfo", "type": "object", "required": [ "networks" ], "properties": { "networks": { "type": "array", "items": { "ref": "#/components/schemas/Network", "type": "object", "truncated": true }, "truncated": true } } }, "hwEncodingAvailable": { "type": "boolean" }, "videoDevices": { "type": "array", "items": { "ref": "#/components/schemas/VideoDevice", "type": "object", "required": [ "path", "name" ], "truncated": true } }, "audioCaptureDevices": { "type": "array", "items": { "ref": "#/components/schemas/AudioDevice", "type": "object", "required": [ "id", "name" ], "truncated": true } }, "onvifDevices": { "type": "array", "items": { "ref": "#/components/schemas/OnvifDevice", "type": "object", "required": [ "id", "name", "address" ], "truncated": true } } } }, "ros": { "ref": "#/components/schemas/DeviceRosState", "type": "object", "nullable": true, "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "ref": "#/components/schemas/RosTopic", "type": "object", "required": [ "name", "type" ], "truncated": true } } } }, "env": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "otaEnabled": { "type": "boolean", "nullable": true }, "onDemand": { "ref": "#/components/schemas/OnDemandState", "type": "object", "nullable": true, "required": [ "buffers" ], "properties": { "buffers": { "type": "array", "items": { "ref": "#/components/schemas/OnDemandBuffer", "type": "object", "required": [ "bufferType", "streams" ], "truncated": true } } } }, "commandProgress": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/CommandProgress", "type": "object", "required": [ "commandId", "progress", "pending" ], "properties": { "commandId": { "type": "string", "truncated": true }, "progress": { "type": "integer", "format": "int64", "truncated": true }, "pending": { "type": "boolean", "truncated": true } } } }, "version": { "type": "string", "nullable": true, "deprecated": true } } }, "enabled": { "type": "boolean" }, "fullyConfigured": { "type": "boolean" }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "Device", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Device", "type": "object", "required": [ "name" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization which contains this device." }, "externalId": { "type": "string", "description": "External ID of this device.", "nullable": true }, "name": { "type": "string", "description": "Name of this device." }, "description": { "type": "string", "description": "Description of this device.", "nullable": true }, "type": { "type": "string", "description": "Enter `default`.", "enum": [ "default", "capture" ] }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user associated with this device.", "nullable": true }, "fleetId": { "type": "string", "format": "uuid", "description": "ID of the fleet with which this device is associated.", "nullable": true }, "publicKey": { "type": "string" }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "deviceScope": { "ref": "#/components/schemas/DeviceScope", "type": "object", "description": "Currently unused, ignore.", "properties": { "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "commands": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "desiredAgentVersion": { "type": "string", "description": "Agent version you want to install if different from the latest version. Must have `formant-sidecar` installed.", "nullable": true }, "desiredConfigurationVersion": { "type": "integer", "format": "int64", "description": "Device configuration version you want to apply. Ignore for new device configuration.", "nullable": true }, "temporaryConfigurationVersion": { "type": "integer", "format": "int64", "nullable": true }, "temporaryConfigurationExpiration": { "type": "string", "format": "date-time", "nullable": true }, "temporaryConfigurationTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "muted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this device.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "followers": { "type": "array", "description": "Users who receive SMS updates from this device.", "items": { "ref": "#/components/schemas/DeviceFollower", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "truncated": true } } } }, "slackChannels": { "type": "array", "description": "Slack channels which receive updates from this device.", "items": { "type": "string" } }, "state": { "ref": "#/components/schemas/DeviceState", "type": "object", "properties": { "agentVersion": { "type": "string", "nullable": true }, "reportedConfiguration": { "ref": "#/components/schemas/DeviceReportedConfigurationState", "type": "object", "nullable": true, "required": [ "version" ], "properties": { "version": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "hwInfo": { "ref": "#/components/schemas/HwInfo", "type": "object", "nullable": true, "properties": { "kernelInfo": { "ref": "#/components/schemas/KernelInfo", "type": "object", "truncated": true }, "osInfo": { "ref": "#/components/schemas/OsInfo", "type": "object", "truncated": true }, "nodeInfo": { "ref": "#/components/schemas/NodeInfo", "type": "object", "truncated": true }, "networkInfo": { "ref": "#/components/schemas/NetworkInfo", "type": "object", "required": [ "networks" ], "truncated": true }, "hwEncodingAvailable": { "type": "boolean", "truncated": true }, "videoDevices": { "type": "array", "items": { "ref": "#/components/schemas/VideoDevice", "type": "object", "required": [ "path", "name" ], "truncated": true }, "truncated": true }, "audioCaptureDevices": { "type": "array", "items": { "ref": "#/components/schemas/AudioDevice", "type": "object", "required": [ "id", "name" ], "truncated": true }, "truncated": true }, "onvifDevices": { "type": "array", "items": { "ref": "#/components/schemas/OnvifDevice", "type": "object", "required": [ "id", "name", "address" ], "truncated": true }, "truncated": true } } }, "ros": { "ref": "#/components/schemas/DeviceRosState", "type": "object", "nullable": true, "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "ref": "#/components/schemas/RosTopic", "type": "object", "required": [ "name", "type" ], "truncated": true }, "truncated": true } } }, "env": { "type": "object", "nullable": true, "additionalProperties": { "type": "string", "truncated": true } }, "otaEnabled": { "type": "boolean", "nullable": true }, "onDemand": { "ref": "#/components/schemas/OnDemandState", "type": "object", "nullable": true, "required": [ "buffers" ], "properties": { "buffers": { "type": "array", "items": { "ref": "#/components/schemas/OnDemandBuffer", "type": "object", "required": [ "bufferType", "streams" ], "truncated": true }, "truncated": true } } }, "commandProgress": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/CommandProgress", "type": "object", "required": [ "commandId", "progress", "pending" ], "truncated": true } }, "version": { "type": "string", "nullable": true, "deprecated": true } } }, "enabled": { "type": "boolean" }, "fullyConfigured": { "type": "boolean" }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices" } }, { "id": "admin.devices.disable", "method": "POST", "pathTemplate": "devices/{deviceId}/disable", "stability": "stable", "summary": "Disable a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.disable", "description": "Disable a device.\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/disable" } }, { "id": "admin.devices.enabled.list", "method": "POST", "pathTemplate": "devices/enabled-devices", "stability": "stable", "summary": "List enabled devices", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.devices.get", "method": "GET", "pathTemplate": "devices/{deviceId}", "stability": "stable", "summary": "Get a device by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.getOne", "description": "Get a device by device ID.\nResource: devices\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Device", "type": "object", "required": [ "name" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization which contains this device." }, "externalId": { "type": "string", "description": "External ID of this device.", "nullable": true }, "name": { "type": "string", "description": "Name of this device." }, "description": { "type": "string", "description": "Description of this device.", "nullable": true }, "type": { "type": "string", "description": "Enter `default`.", "enum": [ "default", "capture" ] }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user associated with this device.", "nullable": true }, "fleetId": { "type": "string", "format": "uuid", "description": "ID of the fleet with which this device is associated.", "nullable": true }, "publicKey": { "type": "string" }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "deviceScope": { "ref": "#/components/schemas/DeviceScope", "type": "object", "description": "Currently unused, ignore.", "properties": { "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "commands": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "desiredAgentVersion": { "type": "string", "description": "Agent version you want to install if different from the latest version. Must have `formant-sidecar` installed.", "nullable": true }, "desiredConfigurationVersion": { "type": "integer", "format": "int64", "description": "Device configuration version you want to apply. Ignore for new device configuration.", "nullable": true }, "temporaryConfigurationVersion": { "type": "integer", "format": "int64", "nullable": true }, "temporaryConfigurationExpiration": { "type": "string", "format": "date-time", "nullable": true }, "temporaryConfigurationTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "muted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this device.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "followers": { "type": "array", "description": "Users who receive SMS updates from this device.", "items": { "ref": "#/components/schemas/DeviceFollower", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "truncated": true } } } }, "slackChannels": { "type": "array", "description": "Slack channels which receive updates from this device.", "items": { "type": "string" } }, "state": { "ref": "#/components/schemas/DeviceState", "type": "object", "properties": { "agentVersion": { "type": "string", "nullable": true }, "reportedConfiguration": { "ref": "#/components/schemas/DeviceReportedConfigurationState", "type": "object", "nullable": true, "required": [ "version" ], "properties": { "version": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "hwInfo": { "ref": "#/components/schemas/HwInfo", "type": "object", "nullable": true, "properties": { "kernelInfo": { "ref": "#/components/schemas/KernelInfo", "type": "object", "truncated": true }, "osInfo": { "ref": "#/components/schemas/OsInfo", "type": "object", "truncated": true }, "nodeInfo": { "ref": "#/components/schemas/NodeInfo", "type": "object", "truncated": true }, "networkInfo": { "ref": "#/components/schemas/NetworkInfo", "type": "object", "required": [ "networks" ], "truncated": true }, "hwEncodingAvailable": { "type": "boolean", "truncated": true }, "videoDevices": { "type": "array", "items": { "ref": "#/components/schemas/VideoDevice", "type": "object", "required": [ "path", "name" ], "truncated": true }, "truncated": true }, "audioCaptureDevices": { "type": "array", "items": { "ref": "#/components/schemas/AudioDevice", "type": "object", "required": [ "id", "name" ], "truncated": true }, "truncated": true }, "onvifDevices": { "type": "array", "items": { "ref": "#/components/schemas/OnvifDevice", "type": "object", "required": [ "id", "name", "address" ], "truncated": true }, "truncated": true } } }, "ros": { "ref": "#/components/schemas/DeviceRosState", "type": "object", "nullable": true, "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "ref": "#/components/schemas/RosTopic", "type": "object", "required": [ "name", "type" ], "truncated": true }, "truncated": true } } }, "env": { "type": "object", "nullable": true, "additionalProperties": { "type": "string", "truncated": true } }, "otaEnabled": { "type": "boolean", "nullable": true }, "onDemand": { "ref": "#/components/schemas/OnDemandState", "type": "object", "nullable": true, "required": [ "buffers" ], "properties": { "buffers": { "type": "array", "items": { "ref": "#/components/schemas/OnDemandBuffer", "type": "object", "required": [ "bufferType", "streams" ], "truncated": true }, "truncated": true } } }, "commandProgress": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/CommandProgress", "type": "object", "required": [ "commandId", "progress", "pending" ], "truncated": true } }, "version": { "type": "string", "nullable": true, "deprecated": true } } }, "enabled": { "type": "boolean" }, "fullyConfigured": { "type": "boolean" }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}" } }, { "id": "admin.devices.latest-health-event.get", "method": "GET", "pathTemplate": "devices/{deviceId}/latest-health-event", "stability": "stable", "summary": "Get latest health event for a device", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.devices.provisioning-token.create", "method": "POST", "pathTemplate": "devices/{deviceId}/provisioning-token", "stability": "stable", "summary": "Create provisioning token for a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.generateDeviceProvisioningToken", "description": "Generate a device provisioning token.\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceProvisioning", "type": "object", "required": [ "token", "expiration" ], "properties": { "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to provision." }, "token": { "type": "string", "description": "Token to provision the device. Generated by the Generate Device Provisioning Token endpoint." }, "expiration": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/provisioning-token" } }, { "id": "admin.devices.query", "method": "POST", "pathTemplate": "devices/query", "stability": "stable", "summary": "Query devices", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.query", "description": "Query devices by name and/or tags\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceQuery", "type": "object", "properties": { "deviceIds": { "type": "array", "description": "Query devices by device ID.", "items": { "type": "string", "format": "uuid" } }, "externalId": { "type": "string", "description": "Query devices by external ID." }, "name": { "type": "string", "description": "Query devices by name." }, "query": { "type": "string", "description": "Query partial device names (case-insensitive)." }, "organizationId": { "type": "string", "description": "Query devices by organization ID." }, "tags": { "description": "Query devices by tags.", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "fleetId": { "type": "string", "format": "uuid", "description": "Query devices by fleet ID.", "nullable": true }, "enabled": { "type": "boolean", "description": "Query devices by enabled status." }, "fullyConfigured": { "type": "boolean", "description": "Query devices by configured status." }, "type": { "type": "string", "description": "Query devices by device type.", "enum": [ "default", "capture" ] }, "count": { "type": "number", "format": "int64", "description": "Limit the number of devices returned by this query (max 1000)." }, "offset": { "type": "number", "format": "int64", "description": "Paginate the results by specifying an offset." }, "createdAfter": { "type": "string", "format": "date-time", "description": "Query devices created after this date." }, "disabledBefore": { "type": "string", "format": "date-time", "description": "Query devices disabled (deleted) before this date." }, "online": { "type": "boolean", "description": "Query online devices." }, "fillOnlineStatus": { "type": "boolean", "description": "Include device online status in the response." }, "fillLastSeen": { "type": "boolean", "description": "Include last seen timestamp in the response." }, "sort": { "type": "array", "description": "Sort order for the query results.", "items": { "ref": "#/components/schemas/DeviceDetailsSort", "type": "object", "required": [ "column", "order" ], "properties": { "column": { "type": "string", "enum": [ "id", "name", "type", "tags", "enabled", "created_at" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] } } } }, "hasExternalId": { "type": "boolean", "description": "Query devices that have an externalId." } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Device", "type": "object", "required": [ "name" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization which contains this device.", "truncated": true }, "externalId": { "type": "string", "description": "External ID of this device.", "nullable": true, "truncated": true }, "name": { "type": "string", "description": "Name of this device.", "truncated": true }, "description": { "type": "string", "description": "Description of this device.", "nullable": true, "truncated": true }, "type": { "type": "string", "description": "Enter `default`.", "enum": [ "default", "capture" ], "truncated": true }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user associated with this device.", "nullable": true, "truncated": true }, "fleetId": { "type": "string", "format": "uuid", "description": "ID of the fleet with which this device is associated.", "nullable": true, "truncated": true }, "publicKey": { "type": "string", "truncated": true }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "truncated": true }, "deviceScope": { "ref": "#/components/schemas/DeviceScope", "type": "object", "description": "Currently unused, ignore.", "truncated": true }, "desiredAgentVersion": { "type": "string", "description": "Agent version you want to install if different from the latest version. Must have `formant-sidecar` installed.", "nullable": true, "truncated": true }, "desiredConfigurationVersion": { "type": "integer", "format": "int64", "description": "Device configuration version you want to apply. Ignore for new device configuration.", "nullable": true, "truncated": true }, "temporaryConfigurationVersion": { "type": "integer", "format": "int64", "nullable": true, "truncated": true }, "temporaryConfigurationExpiration": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "temporaryConfigurationTemplateId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "muted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this device.", "nullable": true, "required": [ "start", "end" ], "truncated": true }, "followers": { "type": "array", "description": "Users who receive SMS updates from this device.", "items": { "ref": "#/components/schemas/DeviceFollower", "type": "object", "required": [ "userId" ], "truncated": true }, "truncated": true }, "slackChannels": { "type": "array", "description": "Slack channels which receive updates from this device.", "items": { "type": "string", "truncated": true }, "truncated": true }, "state": { "ref": "#/components/schemas/DeviceState", "type": "object", "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "fullyConfigured": { "type": "boolean", "truncated": true }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/query" } }, { "id": "admin.devices.tag-history.list", "method": "GET", "pathTemplate": "devices/{deviceId}/tag-history", "stability": "stable", "summary": "List tag history for a device", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.devices.tags.list", "method": "POST", "pathTemplate": "devices/tags", "stability": "stable", "summary": "List device tags", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.getTags", "description": "Get tags across all devices\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceQuery", "type": "object", "properties": { "deviceIds": { "type": "array", "description": "Query devices by device ID.", "items": { "type": "string", "format": "uuid" } }, "externalId": { "type": "string", "description": "Query devices by external ID." }, "name": { "type": "string", "description": "Query devices by name." }, "query": { "type": "string", "description": "Query partial device names (case-insensitive)." }, "organizationId": { "type": "string", "description": "Query devices by organization ID." }, "tags": { "description": "Query devices by tags.", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "fleetId": { "type": "string", "format": "uuid", "description": "Query devices by fleet ID.", "nullable": true }, "enabled": { "type": "boolean", "description": "Query devices by enabled status." }, "fullyConfigured": { "type": "boolean", "description": "Query devices by configured status." }, "type": { "type": "string", "description": "Query devices by device type.", "enum": [ "default", "capture" ] }, "count": { "type": "number", "format": "int64", "description": "Limit the number of devices returned by this query (max 1000)." }, "offset": { "type": "number", "format": "int64", "description": "Paginate the results by specifying an offset." }, "createdAfter": { "type": "string", "format": "date-time", "description": "Query devices created after this date." }, "disabledBefore": { "type": "string", "format": "date-time", "description": "Query devices disabled (deleted) before this date." }, "online": { "type": "boolean", "description": "Query online devices." }, "fillOnlineStatus": { "type": "boolean", "description": "Include device online status in the response." }, "fillLastSeen": { "type": "boolean", "description": "Include last seen timestamp in the response." }, "sort": { "type": "array", "description": "Sort order for the query results.", "items": { "ref": "#/components/schemas/DeviceDetailsSort", "type": "object", "required": [ "column", "order" ], "properties": { "column": { "type": "string", "enum": [ "id", "name", "type", "tags", "enabled", "created_at" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] } } } }, "hasExternalId": { "type": "boolean", "description": "Query devices that have an externalId." } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TagsResponse", "type": "object", "required": [ "tags" ], "properties": { "tags": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/tags" } }, { "id": "admin.devices.unprovision", "method": "POST", "pathTemplate": "devices/{deviceId}/unprovision", "stability": "stable", "summary": "Unprovision a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.unprovisionDevice", "description": "Unprovision a device by device ID.\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/unprovision" } }, { "id": "admin.devices.update", "method": "PATCH", "pathTemplate": "devices/{deviceId}", "stability": "stable", "summary": "Update a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.patch", "description": "Update an existing device.\nResource: devices\nAuthorized roles: administrator, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialDevice", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization which contains this device." }, "externalId": { "type": "string", "description": "External ID of this device.", "nullable": true }, "name": { "type": "string", "description": "Name of this device." }, "description": { "type": "string", "description": "Description of this device.", "nullable": true }, "type": { "type": "string", "description": "Enter `default`.", "enum": [ "default", "capture" ] }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user associated with this device.", "nullable": true }, "fleetId": { "type": "string", "format": "uuid", "description": "ID of the fleet with which this device is associated.", "nullable": true }, "publicKey": { "type": "string" }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "deviceScope": { "ref": "#/components/schemas/DeviceScope", "type": "object", "description": "Currently unused, ignore.", "properties": { "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "commands": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "desiredAgentVersion": { "type": "string", "description": "Agent version you want to install if different from the latest version. Must have `formant-sidecar` installed.", "nullable": true }, "desiredConfigurationVersion": { "type": "integer", "format": "int64", "description": "Device configuration version you want to apply. Ignore for new device configuration.", "nullable": true }, "temporaryConfigurationVersion": { "type": "integer", "format": "int64", "nullable": true }, "temporaryConfigurationExpiration": { "type": "string", "format": "date-time", "nullable": true }, "temporaryConfigurationTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "muted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this device.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "followers": { "type": "array", "description": "Users who receive SMS updates from this device.", "items": { "ref": "#/components/schemas/DeviceFollower", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid" } } } }, "slackChannels": { "type": "array", "description": "Slack channels which receive updates from this device.", "items": { "type": "string" } }, "state": { "ref": "#/components/schemas/DeviceState", "type": "object", "properties": { "agentVersion": { "type": "string", "nullable": true }, "reportedConfiguration": { "ref": "#/components/schemas/DeviceReportedConfigurationState", "type": "object", "nullable": true, "required": [ "version" ], "properties": { "version": { "type": "integer", "format": "int64", "nullable": true } } }, "hwInfo": { "ref": "#/components/schemas/HwInfo", "type": "object", "nullable": true, "properties": { "kernelInfo": { "ref": "#/components/schemas/KernelInfo", "type": "object", "properties": { "version": { "type": "string", "truncated": true }, "release": { "type": "string", "truncated": true }, "architecture": { "type": "string", "truncated": true } } }, "osInfo": { "ref": "#/components/schemas/OsInfo", "type": "object", "properties": { "name": { "type": "string", "truncated": true }, "vendor": { "type": "string", "truncated": true }, "release": { "type": "string", "truncated": true }, "version": { "type": "string", "truncated": true } } }, "nodeInfo": { "ref": "#/components/schemas/NodeInfo", "type": "object", "properties": { "hostname": { "type": "string", "truncated": true }, "machineid": { "type": "string", "truncated": true }, "timezone": { "type": "string", "truncated": true } } }, "networkInfo": { "ref": "#/components/schemas/NetworkInfo", "type": "object", "required": [ "networks" ], "properties": { "networks": { "type": "array", "items": { "ref": "#/components/schemas/Network", "type": "object", "truncated": true }, "truncated": true } } }, "hwEncodingAvailable": { "type": "boolean" }, "videoDevices": { "type": "array", "items": { "ref": "#/components/schemas/VideoDevice", "type": "object", "required": [ "path", "name" ], "truncated": true } }, "audioCaptureDevices": { "type": "array", "items": { "ref": "#/components/schemas/AudioDevice", "type": "object", "required": [ "id", "name" ], "truncated": true } }, "onvifDevices": { "type": "array", "items": { "ref": "#/components/schemas/OnvifDevice", "type": "object", "required": [ "id", "name", "address" ], "truncated": true } } } }, "ros": { "ref": "#/components/schemas/DeviceRosState", "type": "object", "nullable": true, "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "ref": "#/components/schemas/RosTopic", "type": "object", "required": [ "name", "type" ], "truncated": true } } } }, "env": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "otaEnabled": { "type": "boolean", "nullable": true }, "onDemand": { "ref": "#/components/schemas/OnDemandState", "type": "object", "nullable": true, "required": [ "buffers" ], "properties": { "buffers": { "type": "array", "items": { "ref": "#/components/schemas/OnDemandBuffer", "type": "object", "required": [ "bufferType", "streams" ], "truncated": true } } } }, "commandProgress": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/CommandProgress", "type": "object", "required": [ "commandId", "progress", "pending" ], "properties": { "commandId": { "type": "string", "truncated": true }, "progress": { "type": "integer", "format": "int64", "truncated": true }, "pending": { "type": "boolean", "truncated": true } } } }, "version": { "type": "string", "nullable": true, "deprecated": true } } }, "enabled": { "type": "boolean" }, "fullyConfigured": { "type": "boolean" }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialDevice", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Device", "type": "object", "required": [ "name" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization which contains this device." }, "externalId": { "type": "string", "description": "External ID of this device.", "nullable": true }, "name": { "type": "string", "description": "Name of this device." }, "description": { "type": "string", "description": "Description of this device.", "nullable": true }, "type": { "type": "string", "description": "Enter `default`.", "enum": [ "default", "capture" ] }, "userId": { "type": "string", "format": "uuid", "description": "ID of the user associated with this device.", "nullable": true }, "fleetId": { "type": "string", "format": "uuid", "description": "ID of the fleet with which this device is associated.", "nullable": true }, "publicKey": { "type": "string" }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "deviceScope": { "ref": "#/components/schemas/DeviceScope", "type": "object", "description": "Currently unused, ignore.", "properties": { "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "commands": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "desiredAgentVersion": { "type": "string", "description": "Agent version you want to install if different from the latest version. Must have `formant-sidecar` installed.", "nullable": true }, "desiredConfigurationVersion": { "type": "integer", "format": "int64", "description": "Device configuration version you want to apply. Ignore for new device configuration.", "nullable": true }, "temporaryConfigurationVersion": { "type": "integer", "format": "int64", "nullable": true }, "temporaryConfigurationExpiration": { "type": "string", "format": "date-time", "nullable": true }, "temporaryConfigurationTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "muted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this device.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "followers": { "type": "array", "description": "Users who receive SMS updates from this device.", "items": { "ref": "#/components/schemas/DeviceFollower", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "truncated": true } } } }, "slackChannels": { "type": "array", "description": "Slack channels which receive updates from this device.", "items": { "type": "string" } }, "state": { "ref": "#/components/schemas/DeviceState", "type": "object", "properties": { "agentVersion": { "type": "string", "nullable": true }, "reportedConfiguration": { "ref": "#/components/schemas/DeviceReportedConfigurationState", "type": "object", "nullable": true, "required": [ "version" ], "properties": { "version": { "type": "integer", "format": "int64", "nullable": true, "truncated": true } } }, "hwInfo": { "ref": "#/components/schemas/HwInfo", "type": "object", "nullable": true, "properties": { "kernelInfo": { "ref": "#/components/schemas/KernelInfo", "type": "object", "truncated": true }, "osInfo": { "ref": "#/components/schemas/OsInfo", "type": "object", "truncated": true }, "nodeInfo": { "ref": "#/components/schemas/NodeInfo", "type": "object", "truncated": true }, "networkInfo": { "ref": "#/components/schemas/NetworkInfo", "type": "object", "required": [ "networks" ], "truncated": true }, "hwEncodingAvailable": { "type": "boolean", "truncated": true }, "videoDevices": { "type": "array", "items": { "ref": "#/components/schemas/VideoDevice", "type": "object", "required": [ "path", "name" ], "truncated": true }, "truncated": true }, "audioCaptureDevices": { "type": "array", "items": { "ref": "#/components/schemas/AudioDevice", "type": "object", "required": [ "id", "name" ], "truncated": true }, "truncated": true }, "onvifDevices": { "type": "array", "items": { "ref": "#/components/schemas/OnvifDevice", "type": "object", "required": [ "id", "name", "address" ], "truncated": true }, "truncated": true } } }, "ros": { "ref": "#/components/schemas/DeviceRosState", "type": "object", "nullable": true, "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "ref": "#/components/schemas/RosTopic", "type": "object", "required": [ "name", "type" ], "truncated": true }, "truncated": true } } }, "env": { "type": "object", "nullable": true, "additionalProperties": { "type": "string", "truncated": true } }, "otaEnabled": { "type": "boolean", "nullable": true }, "onDemand": { "ref": "#/components/schemas/OnDemandState", "type": "object", "nullable": true, "required": [ "buffers" ], "properties": { "buffers": { "type": "array", "items": { "ref": "#/components/schemas/OnDemandBuffer", "type": "object", "required": [ "bufferType", "streams" ], "truncated": true }, "truncated": true } } }, "commandProgress": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/CommandProgress", "type": "object", "required": [ "commandId", "progress", "pending" ], "truncated": true } }, "version": { "type": "string", "nullable": true, "deprecated": true } } }, "enabled": { "type": "boolean" }, "fullyConfigured": { "type": "boolean" }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}" } }, { "id": "admin.devices.updated-configuration.get", "method": "GET", "pathTemplate": "devices/{deviceId}/updated-configuration", "stability": "stable", "summary": "Get updated desired configuration for a device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.getUpdatedConfiguration", "description": "Check for updated device configuration\nResource: devices\nAuthorized roles: device", "parameters": { "cookie": [], "header": [ { "deprecated": false, "description": null, "location": "header", "name": "app-version", "required": false, "schema": { "type": "string" } } ], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [ { "deprecated": false, "description": null, "location": "query", "name": "agentWallClockTimestamp", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "deprecated": false, "description": null, "location": "query", "name": "reportedConfigurationVersion", "required": false, "schema": { "type": "integer", "format": "int64" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UpdatedConfigurationResponse", "type": "object", "properties": { "desiredConfiguration": { "ref": "#/components/schemas/DeviceConfiguration", "type": "object", "nullable": true, "required": [ "document" ], "properties": { "deviceId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int64" }, "document": { "ref": "#/components/schemas/DeviceConfigurationDocument", "type": "object", "properties": { "tags": { "type": "object", "truncated": true }, "resources": { "ref": "#/components/schemas/DeviceResourcesConfiguration", "type": "object", "truncated": true }, "telemetry": { "ref": "#/components/schemas/DeviceTelemetryConfiguration", "type": "object", "truncated": true }, "realtime": { "ref": "#/components/schemas/DeviceRealtimeConfiguration", "type": "object", "truncated": true }, "application": { "ref": "#/components/schemas/DeviceApplicationConfiguration", "type": "object", "truncated": true }, "blobData": { "ref": "#/components/schemas/DeviceBlobData", "type": "object", "required": [ "data" ], "truncated": true }, "terminalAccess": { "type": "boolean", "nullable": true, "truncated": true }, "teleop": { "ref": "#/components/schemas/DeviceTeleopConfiguration", "type": "object", "truncated": true }, "portForwarding": { "ref": "#/components/schemas/DevicePortForwardingConfiguration", "type": "object", "truncated": true }, "diagnostics": { "ref": "#/components/schemas/DeviceDiagnosticsConfiguration", "type": "object", "truncated": true }, "urdfFiles": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "adapters": { "type": "array", "items": { "ref": "#/components/schemas/AdapterConfiguration", "type": "object", "required": [ "id", "name", "fileId", "execCommand" ], "truncated": true }, "truncated": true }, "rtcInfo": { "ref": "#/components/schemas/RtcInfo", "type": "object", "truncated": true } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/{id}/updated-configuration" } }, { "id": "admin.devices.validate-stream-configuration", "method": "POST", "pathTemplate": "devices/validate-stream-configuration", "stability": "stable", "summary": "Validate a device stream configuration", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "DeviceController.validateStreamConfiguration", "description": "Validate a device stream configuration\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceStreamConfiguration", "type": "object", "required": [ "name", "configuration" ], "properties": { "name": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "configuration": { "oneOf": [ { "ref": "#/components/schemas/DeviceStreamHardwareConfiguration", "type": "object", "required": [ "type", "hwDescriptor", "hardwareType" ], "properties": { "type": { "type": "string", "enum": [ "hardware" ] }, "hwDescriptor": { "type": "string" }, "audioHwDescriptor": { "type": "string" }, "hardwareType": { "type": "string", "enum": [ "ip", "usb" ] }, "rtspEncodingNeeded": { "type": "boolean" }, "isOnvif": { "type": "boolean" }, "overlayClock": { "type": "boolean" }, "ipCamUsername": { "type": "string" }, "ipCamPassword": { "type": "string" }, "bitrate": { "type": "integer", "format": "int64" }, "disableAdaptiveQuality": { "type": "boolean" }, "quality": { "type": "string", "enum": [ "1080p", "720p", "480p", "360p" ] } } }, { "ref": "#/components/schemas/DeviceStreamCustomConfiguration", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "custom" ] } } }, { "ref": "#/components/schemas/DeviceStreamRosTopicConfiguration", "type": "object", "required": [ "type", "topic", "rosVersion" ], "properties": { "type": { "type": "string", "enum": [ "ros-topic" ] }, "topic": { "type": "string" }, "path": { "type": "string" }, "rosVersion": { "type": "string", "enum": [ "ROS-1", "ROS-2" ] } } }, { "ref": "#/components/schemas/DeviceStreamRosLocalizationConfiguration", "type": "object", "required": [ "type", "baseReferenceFrame", "odomTopic", "rosVersion" ], "properties": { "type": { "type": "string", "enum": [ "ros-localization" ] }, "baseReferenceFrame": { "type": "string" }, "odomTopic": { "type": "string" }, "mapTopic": { "type": "string" }, "pointCloudTopics": { "type": "array", "items": { "type": "string", "truncated": true } }, "pathTopic": { "type": "string" }, "goalTopic": { "type": "string" }, "rosVersion": { "type": "string", "enum": [ "ROS-1", "ROS-2" ] } } }, { "ref": "#/components/schemas/DeviceStreamRosTransformTreeConfiguration", "type": "object", "required": [ "type", "baseReferenceFrame", "rosVersion" ], "properties": { "type": { "type": "string", "enum": [ "ros-transform-tree" ] }, "baseReferenceFrame": { "type": "string" }, "rosVersion": { "type": "string", "enum": [ "ROS-1", "ROS-2" ] } } }, { "ref": "#/components/schemas/DeviceStreamDirectoryWatchConfiguration", "type": "object", "required": [ "type", "directory" ], "properties": { "type": { "type": "string", "enum": [ "directory-watch" ] }, "directory": { "type": "string" }, "extension": { "type": "string" }, "fileType": { "type": "string", "enum": [ "file", "image", "video", "point-cloud" ] } } }, { "ref": "#/components/schemas/DeviceStreamFileTailConfiguration", "type": "object", "required": [ "type", "filename" ], "properties": { "type": { "type": "string", "enum": [ "file-tail" ] }, "filename": { "type": "string" }, "fileFormat": { "type": "string", "enum": [ "plain-text", "json" ] }, "timeKey": { "type": "string" }, "timeFormat": { "type": "string" }, "regex": { "type": "string" } } } ] }, "throttleHz": { "type": "number", "nullable": true }, "disabled": { "type": "boolean", "nullable": true }, "onDemand": { "type": "boolean", "nullable": true }, "validation": { "ref": "#/components/schemas/ValidationConfiguration", "type": "object", "nullable": true, "required": [ "schemaId" ], "properties": { "schemaId": { "type": "string" } } }, "transform": { "ref": "#/components/schemas/DeviceStreamTransformConfiguration", "type": "object", "nullable": true, "properties": { "videoEncodingEnabled": { "type": "boolean" } } }, "quality": { "type": "string", "enum": [ "1080p", "720p", "480p", "360p" ] } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceStreamConfiguration", "required": true }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/devices/validate-stream-configuration" } }, { "id": "admin.event-trigger-groups.create", "method": "POST", "pathTemplate": "event-trigger-groups", "stability": "stable", "summary": "Create an event trigger group", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerGroupController.post", "description": "Create event trigger group\nResource: events\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CreateEventTriggerGroupRequest", "type": "object", "required": [ "phoneNumbers", "deviceIds", "eventTriggers" ], "properties": { "phoneNumbers": { "type": "array", "items": { "type": "string" } }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "eventTriggers": { "ref": "#/components/schemas/EventTrigger", "type": "array", "required": [ "eventType", "message", "interval", "severity", "commands", "notificationEnabled", "condition", "exitCondition", "predicate", "triggeredConfiguration", "workflows", "statefulTriggerConfiguration", "forwardingConfiguration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "message": { "type": "string" }, "condition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "exitCondition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "predicate": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } } ] }, "interval": { "type": "integer", "format": "int64" }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] }, "enabled": { "type": "boolean" }, "format": { "type": "string" }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "properties": { "configurationDurationMinutes": { "type": "integer", "format": "int64" }, "configurationTemplateId": { "type": "string", "format": "uuid" } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "properties": { "commandTemplateId": { "type": "string", "format": "uuid", "truncated": true }, "parameterValue": { "type": "string", "truncated": true } } } }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "properties": { "workflowId": { "type": "string", "truncated": true } } } }, "notificationEnabled": { "type": "boolean" }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "properties": { "emitOnEnteringState": { "type": "boolean" }, "emitOnLeavingState": { "type": "boolean" } } }, "isStateful": { "type": "boolean" }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "properties": { "pagerduty": { "type": "boolean" }, "slackChannels": { "type": "array", "items": { "type": "string", "truncated": true } }, "webhooks": { "type": "array", "items": { "type": "string", "truncated": true } }, "sms": { "type": "boolean" }, "slack": { "type": "boolean" }, "deviceSlackChannels": { "type": "boolean" } } }, "setsDeviceColor": { "type": "boolean" }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "properties": { "userId": { "type": "string", "format": "uuid" }, "personaId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "goal": { "type": "string" }, "model": { "type": "string", "items": { "type": "string", "enum": [ "o3", "o3-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "gpt-5", "gpt-5-mini", "gpt-5-nano", "claude-sonnet-4-20250514", "claude-opus-4-20250514", "claude-sonnet-4-5" ], "truncated": true } } } }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } }, "items": { "ref": "#/components/schemas/EventTrigger", "recursive": true } }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "isAlreadyOptedIn": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "CreateEventTriggerGroupRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTriggerGroup", "type": "object", "required": [ "deviceScope", "smsTags" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "phoneNumbers": { "type": "array", "description": "User's phone numbers (e.g., +14155550100).", "items": { "type": "string" } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-trigger-groups" } }, { "id": "admin.event-trigger-groups.get", "method": "GET", "pathTemplate": "event-trigger-groups/{eventTriggerGroupId}", "stability": "stable", "summary": "Get an event trigger group by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerGroupController.getOne", "description": "Get an event trigger group\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTriggerGroup", "type": "object", "required": [ "deviceScope", "smsTags" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "phoneNumbers": { "type": "array", "description": "User's phone numbers (e.g., +14155550100).", "items": { "type": "string" } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-trigger-groups/{id}" } }, { "id": "admin.event-trigger-groups.list", "method": "GET", "pathTemplate": "event-trigger-groups", "stability": "stable", "summary": "List event trigger groups", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerGroupController.getAll", "description": "List all event trigger groups\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTriggerGroupListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerGroup", "type": "object", "required": [ "deviceScope", "smsTags" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "truncated": true }, "smsTags": { "type": "object", "truncated": true }, "phoneNumbers": { "type": "array", "description": "User's phone numbers (e.g., +14155550100).", "items": { "type": "string", "truncated": true }, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-trigger-groups" } }, { "id": "admin.event-trigger-groups.update", "method": "PATCH", "pathTemplate": "event-trigger-groups/{eventTriggerGroupId}", "stability": "stable", "summary": "Update an event trigger group", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerGroupController.patch", "description": "Update event trigger group\nResource: events\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialEventTriggerGroup", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "phoneNumbers": { "type": "array", "description": "User's phone numbers (e.g., +14155550100).", "items": { "type": "string" } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialEventTriggerGroup", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTriggerGroup", "type": "object", "required": [ "deviceScope", "smsTags" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "phoneNumbers": { "type": "array", "description": "User's phone numbers (e.g., +14155550100).", "items": { "type": "string" } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-trigger-groups/{id}" } }, { "id": "admin.event-triggers.create", "method": "POST", "pathTemplate": "event-triggers", "stability": "stable", "summary": "Create an event trigger", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerController.post", "description": "Create event trigger\nResource: events\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTrigger", "type": "object", "required": [ "eventType", "message", "interval", "severity", "commands", "notificationEnabled", "condition", "exitCondition", "predicate", "triggeredConfiguration", "workflows", "statefulTriggerConfiguration", "forwardingConfiguration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "message": { "type": "string" }, "condition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ] }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ] }, "value": { "type": "number" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ] }, "value": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ] }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ] }, "conditions": { "type": "object" }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ] }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ] }, "jqQuery": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ] }, "stream": { "type": "string" } } } ] }, "exitCondition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ] }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ] }, "value": { "type": "number" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ] }, "value": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ] }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ] }, "conditions": { "type": "object" }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ] }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ] }, "jqQuery": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ] }, "stream": { "type": "string" } } } ] }, "predicate": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } } ] }, "interval": { "type": "integer", "format": "int64" }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] }, "enabled": { "type": "boolean" }, "format": { "type": "string" }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "properties": { "configurationDurationMinutes": { "type": "integer", "format": "int64" }, "configurationTemplateId": { "type": "string", "format": "uuid" } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "properties": { "commandTemplateId": { "type": "string", "format": "uuid" }, "parameterValue": { "type": "string" } } } }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "properties": { "workflowId": { "type": "string" } } } }, "notificationEnabled": { "type": "boolean" }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "properties": { "emitOnEnteringState": { "type": "boolean" }, "emitOnLeavingState": { "type": "boolean" } } }, "isStateful": { "type": "boolean" }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "properties": { "pagerduty": { "type": "boolean" }, "slackChannels": { "type": "array", "items": { "type": "string" } }, "webhooks": { "type": "array", "items": { "type": "string" } }, "sms": { "type": "boolean" }, "slack": { "type": "boolean" }, "deviceSlackChannels": { "type": "boolean" } } }, "setsDeviceColor": { "type": "boolean" }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "properties": { "userId": { "type": "string", "format": "uuid" }, "personaId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "goal": { "type": "string" }, "model": { "type": "string", "items": { "type": "string", "enum": [ "o3", "o3-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "gpt-5", "gpt-5-mini", "gpt-5-nano", "claude-sonnet-4-20250514", "claude-opus-4-20250514", "claude-sonnet-4-5" ] } } } }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "EventTrigger", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTrigger", "type": "object", "required": [ "eventType", "message", "interval", "severity", "commands", "notificationEnabled", "condition", "exitCondition", "predicate", "triggeredConfiguration", "workflows", "statefulTriggerConfiguration", "forwardingConfiguration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "message": { "type": "string" }, "condition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "exitCondition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "predicate": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } } ] }, "interval": { "type": "integer", "format": "int64" }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] }, "enabled": { "type": "boolean" }, "format": { "type": "string" }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "properties": { "configurationDurationMinutes": { "type": "integer", "format": "int64" }, "configurationTemplateId": { "type": "string", "format": "uuid" } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "properties": { "commandTemplateId": { "type": "string", "format": "uuid", "truncated": true }, "parameterValue": { "type": "string", "truncated": true } } } }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "properties": { "workflowId": { "type": "string", "truncated": true } } } }, "notificationEnabled": { "type": "boolean" }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "properties": { "emitOnEnteringState": { "type": "boolean" }, "emitOnLeavingState": { "type": "boolean" } } }, "isStateful": { "type": "boolean" }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "properties": { "pagerduty": { "type": "boolean" }, "slackChannels": { "type": "array", "items": { "type": "string", "truncated": true } }, "webhooks": { "type": "array", "items": { "type": "string", "truncated": true } }, "sms": { "type": "boolean" }, "slack": { "type": "boolean" }, "deviceSlackChannels": { "type": "boolean" } } }, "setsDeviceColor": { "type": "boolean" }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "properties": { "userId": { "type": "string", "format": "uuid" }, "personaId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "goal": { "type": "string" }, "model": { "type": "string", "items": { "type": "string", "enum": [ "o3", "o3-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "gpt-5", "gpt-5-mini", "gpt-5-nano", "claude-sonnet-4-20250514", "claude-opus-4-20250514", "claude-sonnet-4-5" ], "truncated": true } } } }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-triggers" } }, { "id": "admin.event-triggers.get", "method": "GET", "pathTemplate": "event-triggers/{eventTriggerId}", "stability": "stable", "summary": "Get an event trigger by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerController.getOne", "description": "Get an event trigger\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTrigger", "type": "object", "required": [ "eventType", "message", "interval", "severity", "commands", "notificationEnabled", "condition", "exitCondition", "predicate", "triggeredConfiguration", "workflows", "statefulTriggerConfiguration", "forwardingConfiguration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "message": { "type": "string" }, "condition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "exitCondition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "predicate": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } } ] }, "interval": { "type": "integer", "format": "int64" }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] }, "enabled": { "type": "boolean" }, "format": { "type": "string" }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "properties": { "configurationDurationMinutes": { "type": "integer", "format": "int64" }, "configurationTemplateId": { "type": "string", "format": "uuid" } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "properties": { "commandTemplateId": { "type": "string", "format": "uuid", "truncated": true }, "parameterValue": { "type": "string", "truncated": true } } } }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "properties": { "workflowId": { "type": "string", "truncated": true } } } }, "notificationEnabled": { "type": "boolean" }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "properties": { "emitOnEnteringState": { "type": "boolean" }, "emitOnLeavingState": { "type": "boolean" } } }, "isStateful": { "type": "boolean" }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "properties": { "pagerduty": { "type": "boolean" }, "slackChannels": { "type": "array", "items": { "type": "string", "truncated": true } }, "webhooks": { "type": "array", "items": { "type": "string", "truncated": true } }, "sms": { "type": "boolean" }, "slack": { "type": "boolean" }, "deviceSlackChannels": { "type": "boolean" } } }, "setsDeviceColor": { "type": "boolean" }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "properties": { "userId": { "type": "string", "format": "uuid" }, "personaId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "goal": { "type": "string" }, "model": { "type": "string", "items": { "type": "string", "enum": [ "o3", "o3-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "gpt-5", "gpt-5-mini", "gpt-5-nano", "claude-sonnet-4-20250514", "claude-opus-4-20250514", "claude-sonnet-4-5" ], "truncated": true } } } }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-triggers/{id}" } }, { "id": "admin.event-triggers.list", "method": "GET", "pathTemplate": "event-triggers", "stability": "stable", "summary": "List event triggers", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerController.getAll", "description": "List all event triggers\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTriggerListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/EventTrigger", "type": "object", "required": [ "eventType", "message", "interval", "severity", "commands", "notificationEnabled", "condition", "exitCondition", "predicate", "triggeredConfiguration", "workflows", "statefulTriggerConfiguration", "forwardingConfiguration" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ], "truncated": true }, "message": { "type": "string", "truncated": true }, "condition": { "nullable": true, "truncated": true }, "exitCondition": { "nullable": true, "truncated": true }, "predicate": { "nullable": true, "truncated": true }, "interval": { "type": "integer", "format": "int64", "truncated": true }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ], "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "format": { "type": "string", "truncated": true }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "truncated": true }, "smsTags": { "type": "object", "truncated": true }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "truncated": true }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "truncated": true }, "truncated": true }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "truncated": true }, "truncated": true }, "notificationEnabled": { "type": "boolean", "truncated": true }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "truncated": true }, "isStateful": { "type": "boolean", "truncated": true }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "truncated": true }, "setsDeviceColor": { "type": "boolean", "truncated": true }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-triggers" } }, { "id": "admin.event-triggers.update", "method": "PATCH", "pathTemplate": "event-triggers/{eventTriggerId}", "stability": "stable", "summary": "Update an event trigger", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventTriggerController.patch", "description": "Update event trigger\nResource: events\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialEventTrigger", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "message": { "type": "string" }, "condition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ] }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ] }, "value": { "type": "number" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ] }, "value": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ] }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ] }, "conditions": { "type": "object" }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ] }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ] }, "jqQuery": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ] }, "stream": { "type": "string" } } } ] }, "exitCondition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ] }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ] }, "value": { "type": "number" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ] }, "value": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ] }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ] }, "conditions": { "type": "object" }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ] }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true } }, "operator": { "type": "string", "enum": [ "any", "all" ] }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ] }, "jqQuery": { "type": "string" }, "stream": { "type": "string" } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ] }, "stream": { "type": "string" } } } ] }, "predicate": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string" } } } ] }, "interval": { "type": "integer", "format": "int64" }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] }, "enabled": { "type": "boolean" }, "format": { "type": "string" }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "properties": { "configurationDurationMinutes": { "type": "integer", "format": "int64" }, "configurationTemplateId": { "type": "string", "format": "uuid" } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "properties": { "commandTemplateId": { "type": "string", "format": "uuid" }, "parameterValue": { "type": "string" } } } }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "properties": { "workflowId": { "type": "string" } } } }, "notificationEnabled": { "type": "boolean" }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "properties": { "emitOnEnteringState": { "type": "boolean" }, "emitOnLeavingState": { "type": "boolean" } } }, "isStateful": { "type": "boolean" }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "properties": { "pagerduty": { "type": "boolean" }, "slackChannels": { "type": "array", "items": { "type": "string" } }, "webhooks": { "type": "array", "items": { "type": "string" } }, "sms": { "type": "boolean" }, "slack": { "type": "boolean" }, "deviceSlackChannels": { "type": "boolean" } } }, "setsDeviceColor": { "type": "boolean" }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "properties": { "userId": { "type": "string", "format": "uuid" }, "personaId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "goal": { "type": "string" }, "model": { "type": "string", "items": { "type": "string", "enum": [ "o3", "o3-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "gpt-5", "gpt-5-mini", "gpt-5-nano", "claude-sonnet-4-20250514", "claude-opus-4-20250514", "claude-sonnet-4-5" ] } } } }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialEventTrigger", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventTrigger", "type": "object", "required": [ "eventType", "message", "interval", "severity", "commands", "notificationEnabled", "condition", "exitCondition", "predicate", "triggeredConfiguration", "workflows", "statefulTriggerConfiguration", "forwardingConfiguration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "eventType": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "message": { "type": "string" }, "condition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "exitCondition": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/PresenceEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "presence" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/ThresholdEventTriggerCondition", "type": "object", "required": [ "type", "operator", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "threshold" ], "truncated": true }, "operator": { "type": "string", "enum": [ "<", "<=", ">", ">=", "==", "!=" ], "truncated": true }, "value": { "type": "number", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/RegexEventTriggerCondition", "type": "object", "required": [ "type", "value", "stream" ], "properties": { "type": { "type": "string", "enum": [ "regex" ], "truncated": true }, "value": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BitsetEventTriggerCondition", "type": "object", "required": [ "type", "bitConditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "bitset" ], "truncated": true }, "bitConditions": { "type": "array", "items": { "ref": "#/components/schemas/BitCondition", "type": "object", "required": [ "key", "true", "false" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BatteryEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "battery" ], "truncated": true }, "conditions": { "type": "object", "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/NumericSetEventTriggerCondition", "type": "object", "required": [ "type", "conditions", "operator", "stream" ], "properties": { "type": { "type": "string", "enum": [ "numeric set" ], "truncated": true }, "conditions": { "type": "array", "items": { "ref": "#/components/schemas/NumericCondition", "type": "object", "required": [ "label" ], "truncated": true }, "truncated": true }, "operator": { "type": "string", "enum": [ "any", "all" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/JsonEventTriggerCondition", "type": "object", "required": [ "type", "jqQuery", "stream" ], "properties": { "type": { "type": "string", "enum": [ "json" ], "truncated": true }, "jqQuery": { "type": "string", "truncated": true }, "stream": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/AutoResolveEventTriggerCondition", "type": "object", "required": [ "type", "stream" ], "properties": { "type": { "type": "string", "enum": [ "auto-resolve" ], "truncated": true }, "stream": { "type": "string", "truncated": true } } } ] }, "predicate": { "nullable": true, "oneOf": [ { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/BaseEventTriggerPredicate", "type": "object", "properties": { "message": { "type": "string", "truncated": true } } } ] }, "interval": { "type": "integer", "format": "int64" }, "severity": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] }, "enabled": { "type": "boolean" }, "format": { "type": "string" }, "triggeredConfiguration": { "ref": "#/components/schemas/TriggeredConfiguration", "type": "object", "nullable": true, "required": [ "configurationDurationMinutes", "configurationTemplateId" ], "properties": { "configurationDurationMinutes": { "type": "integer", "format": "int64" }, "configurationTemplateId": { "type": "string", "format": "uuid" } } }, "smsTags": { "type": "object", "additionalProperties": { "type": "string" } }, "deviceScope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "commands": { "type": "array", "items": { "ref": "#/components/schemas/EventTriggerCommand", "type": "object", "required": [ "commandTemplateId" ], "properties": { "commandTemplateId": { "type": "string", "format": "uuid", "truncated": true }, "parameterValue": { "type": "string", "truncated": true } } } }, "workflows": { "type": "array", "nullable": true, "items": { "ref": "#/components/schemas/EventTriggerWorkflow", "type": "object", "properties": { "workflowId": { "type": "string", "truncated": true } } } }, "notificationEnabled": { "type": "boolean" }, "lastTriggeredTime": { "type": "string", "format": "date-time", "nullable": true }, "eventTriggerGroupId": { "type": "string", "format": "uuid", "nullable": true }, "statefulTriggerConfiguration": { "ref": "#/components/schemas/StatefulTriggerConfiguration", "type": "object", "nullable": true, "properties": { "emitOnEnteringState": { "type": "boolean" }, "emitOnLeavingState": { "type": "boolean" } } }, "isStateful": { "type": "boolean" }, "forwardingConfiguration": { "ref": "#/components/schemas/ForwardingConfiguration", "type": "object", "nullable": true, "properties": { "pagerduty": { "type": "boolean" }, "slackChannels": { "type": "array", "items": { "type": "string", "truncated": true } }, "webhooks": { "type": "array", "items": { "type": "string", "truncated": true } }, "sms": { "type": "boolean" }, "slack": { "type": "boolean" }, "deviceSlackChannels": { "type": "boolean" } } }, "setsDeviceColor": { "type": "boolean" }, "theopolis": { "ref": "#/components/schemas/TheopolisConfiguration", "type": "object", "nullable": true, "required": [ "userId", "personaId", "description", "goal" ], "properties": { "userId": { "type": "string", "format": "uuid" }, "personaId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "goal": { "type": "string" }, "model": { "type": "string", "items": { "type": "string", "enum": [ "o3", "o3-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "gpt-5", "gpt-5-mini", "gpt-5-nano", "claude-sonnet-4-20250514", "claude-opus-4-20250514", "claude-sonnet-4-5" ], "truncated": true } } } }, "taskFlowId": { "type": "string", "format": "uuid", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/event-triggers/{id}" } }, { "id": "admin.events.annotation-templates.list", "method": "POST", "pathTemplate": "events/annotation-templates", "stability": "stable", "summary": "List event annotation templates", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.annotationTemplates", "description": "Distinct values of event annotation templates\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UuidListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/annotation-templates" } }, { "id": "admin.events.count", "method": "POST", "pathTemplate": "events/count", "stability": "stable", "summary": "Count events", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.count", "description": "Count events\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/count" } }, { "id": "admin.events.counts", "method": "POST", "pathTemplate": "events/counts", "stability": "stable", "summary": "Get event counts", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.counts", "description": "Count events\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventCounts", "type": "object", "required": [ "total" ], "properties": { "total": { "type": "integer", "format": "int64" }, "info": { "type": "integer", "format": "int64" }, "warn": { "type": "integer", "format": "int64" }, "error": { "type": "integer", "format": "int64" }, "critical": { "type": "integer", "format": "int64" }, "triggered-events": { "type": "integer", "format": "int64" }, "intervention-request": { "type": "integer", "format": "int64" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/counts" } }, { "id": "admin.events.counts-by-device", "method": "POST", "pathTemplate": "events/counts-by-device", "stability": "stable", "summary": "Get event counts by device", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.countsByDevice", "description": "Count events by device\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventCountsByDevice", "type": "object", "required": [ "counts" ], "properties": { "counts": { "type": "array", "items": { "ref": "#/components/schemas/EventCounts", "type": "object", "required": [ "total" ], "properties": { "total": { "type": "integer", "format": "int64", "truncated": true }, "info": { "type": "integer", "format": "int64", "truncated": true }, "warn": { "type": "integer", "format": "int64", "truncated": true }, "error": { "type": "integer", "format": "int64", "truncated": true }, "critical": { "type": "integer", "format": "int64", "truncated": true }, "triggered-events": { "type": "integer", "format": "int64", "truncated": true }, "intervention-request": { "type": "integer", "format": "int64", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/counts-by-device" } }, { "id": "admin.events.devices.list", "method": "POST", "pathTemplate": "events/devices", "stability": "stable", "summary": "List devices in event query scope", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.devices", "description": "Distinct values of event devices\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UuidListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/devices" } }, { "id": "admin.events.event-types.list", "method": "POST", "pathTemplate": "events/event-types", "stability": "stable", "summary": "List event types", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.eventTypes", "description": "Distinct values of event types\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StringListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/event-types" } }, { "id": "admin.events.export-sheet.create", "method": "POST", "pathTemplate": "events/export-sheet", "stability": "stable", "summary": "Export event query results to a sheet", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.exportSheet", "description": "Export events as Google Sheet\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventExportSheetRequest", "type": "object", "required": [ "filter", "appUrlOrigin" ], "properties": { "filter": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "appUrlOrigin": { "type": "string", "format": "url" } } } } }, "contentTypes": [ "application/json" ], "description": "EventExportSheetRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventExportSheetResult", "type": "object", "required": [ "spreadsheetUrl" ], "properties": { "spreadsheetUrl": { "type": "string", "format": "url" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/export-sheet" } }, { "id": "admin.events.get", "method": "GET", "pathTemplate": "events/{eventId}", "stability": "stable", "summary": "Get an event by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.getOne", "description": "Get an event\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/BaseEvent", "type": "object", "required": [ "time" ], "properties": { "type": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/{id}" } }, { "id": "admin.events.histogram", "method": "POST", "pathTemplate": "events/histogram", "stability": "stable", "summary": "Get event histogram", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.histogram", "description": "Event histogram\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/IntervalEventFilter", "type": "object", "required": [ "interval", "timezoneOffsetMinutes" ], "properties": { "interval": { "type": "string", "enum": [ "minute", "hour", "day", "month", "year" ] }, "timezoneOffsetMinutes": { "type": "integer", "format": "int64" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "IntervalEventFilter", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventHistogram", "type": "object", "required": [ "counts" ], "properties": { "counts": { "type": "array", "items": { "ref": "#/components/schemas/EventHistogramEntry", "type": "object", "required": [ "time", "counts" ], "properties": { "time": { "type": "string", "format": "date-time", "truncated": true }, "counts": { "ref": "#/components/schemas/EventCounts", "type": "object", "required": [ "total" ], "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/histogram" } }, { "id": "admin.events.query", "method": "POST", "pathTemplate": "events/query", "stability": "stable", "summary": "Query events", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.query", "description": "Query events\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [ { "deprecated": false, "description": null, "location": "header", "name": "app-id", "required": false, "schema": { "type": "string" } } ], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventQuery", "type": "object", "properties": { "next": { "type": "object" }, "offset": { "type": "integer", "format": "int64" }, "count": { "type": "integer", "format": "int64" }, "sort": { "ref": "#/components/schemas/EventSort", "type": "object", "required": [ "column", "order" ], "properties": { "column": { "type": "string", "enum": [ "type", "message", "device.name", "time", "event.createdAt", "event.updatedAt" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] } } }, "updatedAfter": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "EventQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "ref": "#/components/schemas/DatapointEvent", "type": "object", "required": [ "time", "severity", "interval" ], "truncated": true }, { "ref": "#/components/schemas/DeviceOnlineEvent", "type": "object", "required": [ "time", "severity", "interval" ], "truncated": true }, { "ref": "#/components/schemas/DeviceOfflineEvent", "type": "object", "required": [ "time", "severity", "interval" ], "truncated": true }, { "ref": "#/components/schemas/InterventionRequest", "type": "object", "required": [ "data", "time" ], "truncated": true }, { "ref": "#/components/schemas/InterventionResponse", "type": "object", "required": [ "interventionType", "data", "interventionId", "time" ], "truncated": true }, { "ref": "#/components/schemas/TeleopSessionRecord", "type": "object", "required": [ "time", "sessionId" ], "truncated": true }, { "ref": "#/components/schemas/PortForwardingSessionRecord", "type": "object", "required": [ "time", "sessionId" ], "truncated": true }, { "ref": "#/components/schemas/CommandDeliveryEvent", "type": "object", "required": [ "time", "commandId" ], "truncated": true }, { "ref": "#/components/schemas/CommandRequestEvent", "type": "object", "required": [ "time", "commandId" ], "truncated": true }, { "ref": "#/components/schemas/CommandResponseEvent", "type": "object", "required": [ "time", "commandId" ], "truncated": true }, { "ref": "#/components/schemas/CustomEvent", "type": "object", "required": [ "time" ], "truncated": true }, { "ref": "#/components/schemas/Comment", "type": "object", "required": [ "time" ], "truncated": true }, { "ref": "#/components/schemas/SystemEvent", "type": "object", "required": [ "time" ], "truncated": true }, { "ref": "#/components/schemas/Annotation", "type": "object", "required": [ "time" ], "truncated": true }, { "ref": "#/components/schemas/TaskSummary", "type": "object", "required": [ "taskSummaryFormatId", "report", "taskId", "generatedAt", "time" ], "truncated": true }, { "ref": "#/components/schemas/StatefulEvent", "type": "object", "required": [ "time" ], "truncated": true } ] } }, "next": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/query" } }, { "id": "admin.events.seek", "method": "POST", "pathTemplate": "events/seek", "stability": "stable", "summary": "Seek to event near timestamp", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.seek", "description": "Seek event\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventSeekQuery", "type": "object", "required": [ "direction", "from" ], "properties": { "direction": { "type": "string", "enum": [ "next", "previous" ] }, "from": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "EventSeekQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/seek" } }, { "id": "admin.events.severities.list", "method": "POST", "pathTemplate": "events/severities", "stability": "stable", "summary": "List event severities", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.severities", "description": "Distinct values of event severities\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StringListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/severities" } }, { "id": "admin.events.stream-names.list", "method": "POST", "pathTemplate": "events/stream-names", "stability": "stable", "summary": "List event stream names", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.streamNames", "description": "Distinct values of event stream names\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StringListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/stream-names" } }, { "id": "admin.events.stream-types.list", "method": "POST", "pathTemplate": "events/stream-types", "stability": "stable", "summary": "List event stream types", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.streamTypes", "description": "Distinct values of event stream types\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StringListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/stream-types" } }, { "id": "admin.events.tags.list", "method": "POST", "pathTemplate": "events/tags", "stability": "stable", "summary": "List event tags", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.tags", "description": "Distinct values of event tags\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TagsResponse", "type": "object", "required": [ "tags" ], "properties": { "tags": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/tags" } }, { "id": "admin.events.users.list", "method": "POST", "pathTemplate": "events/users", "stability": "stable", "summary": "List event users", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.users", "description": "Distinct values of event users\nResource: events\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UuidListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/users" } }, { "id": "admin.events.view.create", "method": "POST", "pathTemplate": "events/view", "stability": "stable", "summary": "Create a view scoped to event query results", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "EventController.view", "description": "Mark events as read\nResource: events\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EventFilter", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "viewed": { "type": "boolean" }, "keyword": { "type": "string" }, "message": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] } }, "notificationEnabled": { "type": "boolean" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "annotationTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disableNullMatches": { "type": "boolean" }, "severities": { "type": "array", "items": { "type": "string", "enum": [ "info", "warning", "error", "critical" ] } }, "setsDeviceColor": { "type": "boolean" }, "externalIds": { "type": "array", "items": { "type": "string" } }, "parentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "EventFilter", "required": true }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/events/view" } }, { "id": "admin.files.begin-upload.create", "method": "POST", "pathTemplate": "files/begin-upload", "stability": "stable", "summary": "Begin a file upload", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.beginUpload", "description": "Initiate a file upload. Must be followed by Complete Upload endpoint call.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/BeginUploadRequest", "type": "object", "required": [ "fileName", "fileSize" ], "properties": { "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64" }, "forceOverwrite": { "type": "boolean" }, "contentType": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "BeginUploadRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/BeginUploadResponse", "type": "object", "required": [ "fileId", "uploadId", "partUrls", "partSize" ], "properties": { "fileId": { "type": "string", "format": "uuid", "description": "ID of the file being uploaded." }, "uploadId": { "type": "string", "description": "ID of the upload." }, "partUrls": { "type": "array", "items": { "type": "string" } }, "partSize": { "type": "integer", "format": "int64" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/begin-upload" } }, { "id": "admin.files.complete-upload.create", "method": "POST", "pathTemplate": "files/complete-upload", "stability": "stable", "summary": "Complete a file upload", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.completeUpload", "description": "Complete a file upload. Must be preceded by Begin Upload endpoint call.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CompleteUploadRequest", "type": "object", "required": [ "fileId", "uploadId", "eTags" ], "properties": { "fileId": { "type": "string", "format": "uuid" }, "uploadId": { "type": "string" }, "eTags": { "type": "array", "items": { "type": "string" } }, "forceOverwrite": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "CompleteUploadRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/complete-upload" } }, { "id": "admin.files.delete", "method": "DELETE", "pathTemplate": "files/{fileId}", "stability": "stable", "summary": "Delete a file", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.delete", "description": "Delete a file.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/{id}" } }, { "id": "admin.files.get", "method": "GET", "pathTemplate": "files/{fileId}", "stability": "stable", "summary": "Get a file", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.get", "description": "Get a file by file ID.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CloudFile", "type": "object", "required": [ "name", "organizationId", "userId", "fileId", "fileSize" ], "properties": { "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "fileId": { "type": "string", "format": "uuid" }, "fileSize": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/{id}" } }, { "id": "admin.files.list", "method": "GET", "pathTemplate": "files", "stability": "stable", "summary": "List files", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.list", "description": "List all files in your organizaiton.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CloudFileListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/CloudFile", "type": "object", "required": [ "name", "organizationId", "userId", "fileId", "fileSize" ], "properties": { "name": { "type": "string", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "userId": { "type": "string", "format": "uuid", "truncated": true }, "fileId": { "type": "string", "format": "uuid", "truncated": true }, "fileSize": { "type": "integer", "format": "int64", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files" } }, { "id": "admin.files.query", "method": "POST", "pathTemplate": "files/query", "stability": "stable", "summary": "Query files", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.query", "description": "Query files\nResource: fileStorage\nAuthorized roles: operator, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/QueryFilesRequest", "type": "object", "required": [ "fileIds" ], "properties": { "fileIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "QueryFilesRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/QueryFilesResponse", "type": "object", "required": [ "fileUrls" ], "properties": { "fileUrls": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/query" } }, { "id": "admin.files.update", "method": "PATCH", "pathTemplate": "files/{fileId}", "stability": "stable", "summary": "Update a file", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.patch", "description": "Update a filename or tags for an existing file.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialCloudFile", "type": "object", "properties": { "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "fileId": { "type": "string", "format": "uuid" }, "fileSize": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialCloudFile", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/CloudFile", "type": "object", "required": [ "name", "organizationId", "userId", "fileId", "fileSize" ], "properties": { "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "fileId": { "type": "string", "format": "uuid" }, "fileSize": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/{id}" } }, { "id": "admin.files.url.get", "method": "GET", "pathTemplate": "files/{fileId}/url", "stability": "stable", "summary": "Get a signed URL for a file", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "FileController.getUrl", "description": "Get the signed S3 URL for a file by file ID.\nResource: fileStorage\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/files/{id}/url" } }, { "id": "admin.groups.create", "method": "POST", "pathTemplate": "groups", "stability": "stable", "summary": "Create a group", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "GroupController.post", "description": "Create a group\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Group", "type": "object", "required": [ "name", "tagKey", "tagValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tagKey": { "type": "object" }, "tagValue": { "type": "object" }, "active": { "type": "boolean" }, "enabled": { "type": "boolean" }, "color": { "type": "string", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "Group", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Group", "type": "object", "required": [ "name", "tagKey", "tagValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tagKey": { "type": "object" }, "tagValue": { "type": "object" }, "active": { "type": "boolean" }, "enabled": { "type": "boolean" }, "color": { "type": "string", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/groups" } }, { "id": "admin.groups.delete", "method": "DELETE", "pathTemplate": "groups/{groupId}", "stability": "stable", "summary": "Delete a group", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "GroupController.delete", "description": "Delete a group\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/groups/{id}" } }, { "id": "admin.groups.get", "method": "GET", "pathTemplate": "groups/{groupId}", "stability": "stable", "summary": "Get a group by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "GroupController.getOne", "description": "Get a group\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Group", "type": "object", "required": [ "name", "tagKey", "tagValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tagKey": { "type": "object" }, "tagValue": { "type": "object" }, "active": { "type": "boolean" }, "enabled": { "type": "boolean" }, "color": { "type": "string", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/groups/{id}" } }, { "id": "admin.groups.list", "method": "GET", "pathTemplate": "groups", "stability": "stable", "summary": "List groups", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "GroupController.list", "description": "List groups\nResource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/GroupListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Group", "type": "object", "required": [ "name", "tagKey", "tagValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "tagKey": { "type": "object", "truncated": true }, "tagValue": { "type": "object", "truncated": true }, "active": { "type": "boolean", "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "color": { "type": "string", "nullable": true, "truncated": true }, "parent": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/groups" } }, { "id": "admin.groups.update", "method": "PATCH", "pathTemplate": "groups/{groupId}", "stability": "stable", "summary": "Update a group", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "GroupController.patch", "description": "Update a group\nResource: devices\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialGroup", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tagKey": { "type": "object" }, "tagValue": { "type": "object" }, "active": { "type": "boolean" }, "enabled": { "type": "boolean" }, "color": { "type": "string", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialGroup", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Group", "type": "object", "required": [ "name", "tagKey", "tagValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tagKey": { "type": "object" }, "tagValue": { "type": "object" }, "active": { "type": "boolean" }, "enabled": { "type": "boolean" }, "color": { "type": "string", "nullable": true }, "parent": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/groups/{id}" } }, { "id": "admin.intervention-requests.create", "method": "POST", "pathTemplate": "intervention-requests", "stability": "stable", "summary": "Create an intervention request", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "InterventionRequestController.post", "description": "Create a new intervention request.\nResource: interventions\nAuthorized roles: administrator, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InterventionRequest", "type": "object", "required": [ "data", "time" ], "properties": { "type": { "type": "string", "description": "Enter `intervention-request`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "interventionType": { "type": "string", "description": "`selection` prompts user to select an option from a dropdown menu. `labeling` prompts user to draw a box around and object and give it a label.", "enum": [ "selection", "labeling", "teleop", "physical" ] }, "data": { "oneOf": [ { "ref": "#/components/schemas/SelectionRequestData", "type": "object", "required": [ "instruction", "imageUrl", "options" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request." }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request." }, "options": { "type": "array", "description": "Array of strings to present to the user as selection options.", "items": { "type": "string", "truncated": true } }, "hint": { "type": "integer", "format": "int64", "description": "Index of the option you would like to suggest as the most likely response (zero-indexed)." }, "title": { "type": "string", "description": "Title of the intervention request window." } } }, { "ref": "#/components/schemas/LabelingRequestData", "type": "object", "required": [ "instruction", "imageUrl", "labels" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request." }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request." }, "labels": { "type": "array", "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "truncated": true } }, "hint": { "type": "array", "description": "(x,y) coordinates creating a box around the area in the image you would like to suggest as the most likely location of the object in question.", "items": { "ref": "#/components/schemas/LabeledPolygon", "type": "object", "required": [ "vertices", "labels" ], "truncated": true } }, "title": { "type": "string", "description": "Title of the intervention request window." } } }, { "ref": "#/components/schemas/TeleopRequestData", "type": "object", "required": [ "instruction" ], "properties": { "instruction": { "type": "string" } } }, { "ref": "#/components/schemas/PhysicalRequestData", "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string" }, "metadata": { "type": "object" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } } } ] }, "responses": { "type": "array", "items": { "type": "object" } }, "agentId": { "type": "string", "format": "uuid", "description": "ID of the device which prompts this intervention request." }, "severity": { "type": "string", "description": "Severity of this event (`info`, `warning`, `error`, or `critical`).", "enum": [ "info", "warning", "error", "critical" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "InterventionRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InterventionRequest", "type": "object", "required": [ "data", "time" ], "properties": { "type": { "type": "string", "description": "Enter `intervention-request`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "interventionType": { "type": "string", "description": "`selection` prompts user to select an option from a dropdown menu. `labeling` prompts user to draw a box around and object and give it a label.", "enum": [ "selection", "labeling", "teleop", "physical" ] }, "data": { "oneOf": [ { "ref": "#/components/schemas/SelectionRequestData", "type": "object", "required": [ "instruction", "imageUrl", "options" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request.", "truncated": true }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request.", "truncated": true }, "options": { "type": "array", "description": "Array of strings to present to the user as selection options.", "items": { "type": "string", "truncated": true }, "truncated": true }, "hint": { "type": "integer", "format": "int64", "description": "Index of the option you would like to suggest as the most likely response (zero-indexed).", "truncated": true }, "title": { "type": "string", "description": "Title of the intervention request window.", "truncated": true } } }, { "ref": "#/components/schemas/LabelingRequestData", "type": "object", "required": [ "instruction", "imageUrl", "labels" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request.", "truncated": true }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request.", "truncated": true }, "labels": { "type": "array", "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "truncated": true }, "truncated": true }, "hint": { "type": "array", "description": "(x,y) coordinates creating a box around the area in the image you would like to suggest as the most likely location of the object in question.", "items": { "ref": "#/components/schemas/LabeledPolygon", "type": "object", "required": [ "vertices", "labels" ], "truncated": true }, "truncated": true }, "title": { "type": "string", "description": "Title of the intervention request window.", "truncated": true } } }, { "ref": "#/components/schemas/TeleopRequestData", "type": "object", "required": [ "instruction" ], "properties": { "instruction": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/PhysicalRequestData", "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "truncated": true }, "metadata": { "type": "object", "truncated": true }, "startTime": { "type": "string", "format": "date-time", "truncated": true }, "endTime": { "type": "string", "format": "date-time", "truncated": true } } } ] }, "responses": { "type": "array", "items": { "type": "object" } }, "agentId": { "type": "string", "format": "uuid", "description": "ID of the device which prompts this intervention request." }, "severity": { "type": "string", "description": "Severity of this event (`info`, `warning`, `error`, or `critical`).", "enum": [ "info", "warning", "error", "critical" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/intervention-requests" } }, { "id": "admin.intervention-requests.get", "method": "GET", "pathTemplate": "intervention-requests/{interventionRequestId}", "stability": "stable", "summary": "Get an intervention request", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "InterventionRequestController.getOne", "description": "Get an intervention request by intervention request ID.\nResource: interventions\nAuthorized roles: viewer, device", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InterventionRequest", "type": "object", "required": [ "data", "time" ], "properties": { "type": { "type": "string", "description": "Enter `intervention-request`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "interventionType": { "type": "string", "description": "`selection` prompts user to select an option from a dropdown menu. `labeling` prompts user to draw a box around and object and give it a label.", "enum": [ "selection", "labeling", "teleop", "physical" ] }, "data": { "oneOf": [ { "ref": "#/components/schemas/SelectionRequestData", "type": "object", "required": [ "instruction", "imageUrl", "options" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request.", "truncated": true }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request.", "truncated": true }, "options": { "type": "array", "description": "Array of strings to present to the user as selection options.", "items": { "type": "string", "truncated": true }, "truncated": true }, "hint": { "type": "integer", "format": "int64", "description": "Index of the option you would like to suggest as the most likely response (zero-indexed).", "truncated": true }, "title": { "type": "string", "description": "Title of the intervention request window.", "truncated": true } } }, { "ref": "#/components/schemas/LabelingRequestData", "type": "object", "required": [ "instruction", "imageUrl", "labels" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request.", "truncated": true }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request.", "truncated": true }, "labels": { "type": "array", "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "truncated": true }, "truncated": true }, "hint": { "type": "array", "description": "(x,y) coordinates creating a box around the area in the image you would like to suggest as the most likely location of the object in question.", "items": { "ref": "#/components/schemas/LabeledPolygon", "type": "object", "required": [ "vertices", "labels" ], "truncated": true }, "truncated": true }, "title": { "type": "string", "description": "Title of the intervention request window.", "truncated": true } } }, { "ref": "#/components/schemas/TeleopRequestData", "type": "object", "required": [ "instruction" ], "properties": { "instruction": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/PhysicalRequestData", "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "truncated": true }, "metadata": { "type": "object", "truncated": true }, "startTime": { "type": "string", "format": "date-time", "truncated": true }, "endTime": { "type": "string", "format": "date-time", "truncated": true } } } ] }, "responses": { "type": "array", "items": { "type": "object" } }, "agentId": { "type": "string", "format": "uuid", "description": "ID of the device which prompts this intervention request." }, "severity": { "type": "string", "description": "Severity of this event (`info`, `warning`, `error`, or `critical`).", "enum": [ "info", "warning", "error", "critical" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/intervention-requests/{id}" } }, { "id": "admin.intervention-requests.query", "method": "POST", "pathTemplate": "intervention-requests/query", "stability": "stable", "summary": "Query intervention requests", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.intervention-requests.update", "method": "PATCH", "pathTemplate": "intervention-requests/{interventionRequestId}", "stability": "stable", "summary": "Update an intervention request", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "InterventionRequestController.patch", "description": "Update an existing intervention request.\nResource: interventions\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialInterventionRequest", "type": "object", "properties": { "type": { "type": "string", "description": "Enter `intervention-request`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "interventionType": { "type": "string", "description": "`selection` prompts user to select an option from a dropdown menu. `labeling` prompts user to draw a box around and object and give it a label.", "enum": [ "selection", "labeling", "teleop", "physical" ] }, "data": { "oneOf": [ { "ref": "#/components/schemas/SelectionRequestData", "type": "object", "required": [ "instruction", "imageUrl", "options" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request." }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request." }, "options": { "type": "array", "description": "Array of strings to present to the user as selection options.", "items": { "type": "string", "truncated": true } }, "hint": { "type": "integer", "format": "int64", "description": "Index of the option you would like to suggest as the most likely response (zero-indexed)." }, "title": { "type": "string", "description": "Title of the intervention request window." } } }, { "ref": "#/components/schemas/LabelingRequestData", "type": "object", "required": [ "instruction", "imageUrl", "labels" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request." }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request." }, "labels": { "type": "array", "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "truncated": true } }, "hint": { "type": "array", "description": "(x,y) coordinates creating a box around the area in the image you would like to suggest as the most likely location of the object in question.", "items": { "ref": "#/components/schemas/LabeledPolygon", "type": "object", "required": [ "vertices", "labels" ], "truncated": true } }, "title": { "type": "string", "description": "Title of the intervention request window." } } }, { "ref": "#/components/schemas/TeleopRequestData", "type": "object", "required": [ "instruction" ], "properties": { "instruction": { "type": "string" } } }, { "ref": "#/components/schemas/PhysicalRequestData", "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string" }, "metadata": { "type": "object" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } } } ] }, "responses": { "type": "array", "items": { "type": "object" } }, "agentId": { "type": "string", "format": "uuid", "description": "ID of the device which prompts this intervention request." }, "severity": { "type": "string", "description": "Severity of this event (`info`, `warning`, `error`, or `critical`).", "enum": [ "info", "warning", "error", "critical" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "PartialInterventionRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InterventionRequest", "type": "object", "required": [ "data", "time" ], "properties": { "type": { "type": "string", "description": "Enter `intervention-request`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "interventionType": { "type": "string", "description": "`selection` prompts user to select an option from a dropdown menu. `labeling` prompts user to draw a box around and object and give it a label.", "enum": [ "selection", "labeling", "teleop", "physical" ] }, "data": { "oneOf": [ { "ref": "#/components/schemas/SelectionRequestData", "type": "object", "required": [ "instruction", "imageUrl", "options" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request.", "truncated": true }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request.", "truncated": true }, "options": { "type": "array", "description": "Array of strings to present to the user as selection options.", "items": { "type": "string", "truncated": true }, "truncated": true }, "hint": { "type": "integer", "format": "int64", "description": "Index of the option you would like to suggest as the most likely response (zero-indexed).", "truncated": true }, "title": { "type": "string", "description": "Title of the intervention request window.", "truncated": true } } }, { "ref": "#/components/schemas/LabelingRequestData", "type": "object", "required": [ "instruction", "imageUrl", "labels" ], "properties": { "instruction": { "type": "string", "description": "Prompt to be shown to the user to resolve the intervention request.", "truncated": true }, "imageUrl": { "type": "string", "format": "url", "description": "URL of the image file to be shown during the intervention request.", "truncated": true }, "labels": { "type": "array", "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "truncated": true }, "truncated": true }, "hint": { "type": "array", "description": "(x,y) coordinates creating a box around the area in the image you would like to suggest as the most likely location of the object in question.", "items": { "ref": "#/components/schemas/LabeledPolygon", "type": "object", "required": [ "vertices", "labels" ], "truncated": true }, "truncated": true }, "title": { "type": "string", "description": "Title of the intervention request window.", "truncated": true } } }, { "ref": "#/components/schemas/TeleopRequestData", "type": "object", "required": [ "instruction" ], "properties": { "instruction": { "type": "string", "truncated": true } } }, { "ref": "#/components/schemas/PhysicalRequestData", "type": "object", "required": [ "reason" ], "properties": { "reason": { "type": "string", "truncated": true }, "metadata": { "type": "object", "truncated": true }, "startTime": { "type": "string", "format": "date-time", "truncated": true }, "endTime": { "type": "string", "format": "date-time", "truncated": true } } } ] }, "responses": { "type": "array", "items": { "type": "object" } }, "agentId": { "type": "string", "format": "uuid", "description": "ID of the device which prompts this intervention request." }, "severity": { "type": "string", "description": "Severity of this event (`info`, `warning`, `error`, or `critical`).", "enum": [ "info", "warning", "error", "critical" ] }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/intervention-requests/{id}" } }, { "id": "admin.key-value.delete", "method": "DELETE", "pathTemplate": "key-value/{key}", "stability": "stable", "summary": "Delete a key-value entry", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "KeyValueController.removeItem", "description": "Delete a key-value pair.\nResource: keyValueStorage\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/key-value/{key}" } }, { "id": "admin.key-value.get", "method": "GET", "pathTemplate": "key-value/{key}", "stability": "stable", "summary": "Get a key-value entry", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.key-value.list", "method": "GET", "pathTemplate": "key-value/", "stability": "stable", "summary": "List key-value keys", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "KeyValueController.list", "description": "List all keys in your organization.\nResource: keyValueStorage\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/KeyValue", "type": "object", "required": [ "key", "value" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create a new key-value pair." }, "key": { "description": "Key you want to create." }, "value": { "type": "string", "description": "Value corresponding to the key you want to create." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/key-value/" } }, { "id": "admin.key-value.query", "method": "POST", "pathTemplate": "key-value/query", "stability": "stable", "summary": "Query key-value entries by keys or prefix", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "KeyValueController.query", "description": "List key-value pairs, optionally filtering by key.\nResource: keyValueStorage\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/KeyValueQuery", "type": "object", "properties": { "keys": { "type": "array", "description": "Array of keys you whose key-value pairs you want to query.", "items": { "type": "string" } }, "prefix": { "type": "string", "description": "Filters your query to all key-value pairs which start with this string. Case-sensitive." } } } } }, "contentTypes": [ "application/json" ], "description": "KeyValueQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/KeyValue", "type": "object", "required": [ "key", "value" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create a new key-value pair." }, "key": { "description": "Key you want to create." }, "value": { "type": "string", "description": "Value corresponding to the key you want to create." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/key-value/query" } }, { "id": "admin.key-value.set", "method": "POST", "pathTemplate": "key-value/", "stability": "stable", "summary": "Set a key-value entry", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "KeyValueController.storeItem", "description": "Create a new key-value pair.\nResource: keyValueStorage\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/KeyValue", "type": "object", "required": [ "key", "value" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create a new key-value pair." }, "key": { "description": "Key you want to create." }, "value": { "type": "string", "description": "Value corresponding to the key you want to create." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "KeyValue", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/KeyValue", "type": "object", "required": [ "key", "value" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which you want to create a new key-value pair." }, "key": { "description": "Key you want to create." }, "value": { "type": "string", "description": "Value corresponding to the key you want to create." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/key-value/" } }, { "id": "admin.module-configurations.create", "method": "POST", "pathTemplate": "module-configurations", "stability": "stable", "summary": "Create a module configuration", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.module-configurations.delete", "method": "DELETE", "pathTemplate": "module-configurations/{moduleConfigurationId}", "stability": "stable", "summary": "Delete a module configuration", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.module-configurations.get", "method": "GET", "pathTemplate": "module-configurations/{moduleConfigurationId}", "stability": "stable", "summary": "Get a module configuration by id", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.module-configurations.list", "method": "GET", "pathTemplate": "module-configurations", "stability": "stable", "summary": "List module configurations", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.module-configurations.update", "method": "PATCH", "pathTemplate": "module-configurations/{moduleConfigurationId}", "stability": "stable", "summary": "Update a module configuration", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.modules.create", "method": "POST", "pathTemplate": "modules", "stability": "stable", "summary": "Create a module", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.modules.delete", "method": "DELETE", "pathTemplate": "modules/{moduleId}", "stability": "stable", "summary": "Delete a module", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.modules.get", "method": "GET", "pathTemplate": "modules/{moduleId}", "stability": "stable", "summary": "Get a module by id", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.modules.list", "method": "GET", "pathTemplate": "modules", "stability": "stable", "summary": "List modules", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.modules.update", "method": "PATCH", "pathTemplate": "modules/{moduleId}", "stability": "stable", "summary": "Update a module", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.organizations.get", "method": "GET", "pathTemplate": "organizations/{organizationId}", "stability": "stable", "summary": "Get organization by id", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.roles.by-user.get", "method": "GET", "pathTemplate": "roles/by-user/{userId}", "stability": "stable", "summary": "Get role by user id", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.roles.create", "method": "POST", "pathTemplate": "roles", "stability": "stable", "summary": "Create a role", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "RoleController.post", "description": "Create a new role.\nResource: roles\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Role", "type": "object", "required": [ "name", "policies" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs." }, "name": { "type": "string", "description": "Name of this role." }, "policies": { "description": "Access policies of this role in JSON format." }, "isImmutable": { "type": "boolean", "description": "Can this role be changed after creation?" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "Role", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Role", "type": "object", "required": [ "name", "policies" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs." }, "name": { "type": "string", "description": "Name of this role." }, "policies": { "description": "Access policies of this role in JSON format." }, "isImmutable": { "type": "boolean", "description": "Can this role be changed after creation?" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/roles" } }, { "id": "admin.roles.delete", "method": "DELETE", "pathTemplate": "roles/{roleId}", "stability": "stable", "summary": "Delete a role", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "RoleController.delete", "description": "Delete a role.\nResource: roles\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/roles/{id}" } }, { "id": "admin.roles.get", "method": "GET", "pathTemplate": "roles/{roleId}", "stability": "stable", "summary": "Get a role by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "RoleController.getOne", "description": "Get a role name by role ID.\nResource: roles\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Role", "type": "object", "required": [ "name", "policies" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs." }, "name": { "type": "string", "description": "Name of this role." }, "policies": { "description": "Access policies of this role in JSON format." }, "isImmutable": { "type": "boolean", "description": "Can this role be changed after creation?" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/roles/{id}" } }, { "id": "admin.roles.list", "method": "GET", "pathTemplate": "roles", "stability": "stable", "summary": "List roles", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "RoleController.list", "description": "List all roles in your organization.\nResource: roles\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/RoleListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Role", "type": "object", "required": [ "name", "policies" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs.", "truncated": true }, "name": { "type": "string", "description": "Name of this role.", "truncated": true }, "policies": { "description": "Access policies of this role in JSON format.", "truncated": true }, "isImmutable": { "type": "boolean", "description": "Can this role be changed after creation?", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/roles/" } }, { "id": "admin.roles.update", "method": "PATCH", "pathTemplate": "roles/{roleId}", "stability": "stable", "summary": "Update a role", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "RoleController.patch", "description": "Update an existing role.\nResource: roles\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialRole", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs." }, "name": { "type": "string", "description": "Name of this role." }, "policies": { "description": "Access policies of this role in JSON format." }, "isImmutable": { "type": "boolean", "description": "Can this role be changed after creation?" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialRole", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Role", "type": "object", "required": [ "name", "policies" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs." }, "name": { "type": "string", "description": "Name of this role." }, "policies": { "description": "Access policies of this role in JSON format." }, "isImmutable": { "type": "boolean", "description": "Can this role be changed after creation?" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/roles/{id}" } }, { "id": "admin.schedules.create", "method": "POST", "pathTemplate": "schedules", "stability": "stable", "summary": "Create a schedule", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ScheduleController.post", "description": "Create a new command schedule.\nResource: schedules\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Schedule", "type": "object", "required": [ "name", "description", "type", "durationMs", "timezone", "deviceId", "at", "cron", "commandTemplateId", "parameterValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this new schedule." }, "name": { "type": "string", "description": "Name of this schedule." }, "description": { "type": "string", "description": "User-friendly description of this command schedule." }, "type": { "type": "string", "description": "Enter `command`.", "enum": [ "command", "run-workflow", "generate-insights", "compose-operation" ] }, "at": { "type": "string", "format": "date-time", "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`", "nullable": true }, "cron": { "type": "string", "description": "Frequency of this command schedule, as defined at https://crontab.guru", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "description": "Enter `0` for this parameter." }, "timezone": { "type": "string", "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format." }, "displayTimezone": { "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "description": "You must create a command template before you can schedule this command.", "nullable": true }, "composeOperationId": { "type": "string", "format": "uuid", "description": "Runs theopolis task source.", "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "parameterValue": { "type": "string", "description": "Value of the command parameter to be sent with this scheduled command.", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to which to send this command." }, "status": { "type": "string", "description": "Internal use only, ignore." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Schedule", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Schedule", "type": "object", "required": [ "name", "description", "type", "durationMs", "timezone", "deviceId", "at", "cron", "commandTemplateId", "parameterValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this new schedule." }, "name": { "type": "string", "description": "Name of this schedule." }, "description": { "type": "string", "description": "User-friendly description of this command schedule." }, "type": { "type": "string", "description": "Enter `command`.", "enum": [ "command", "run-workflow", "generate-insights", "compose-operation" ] }, "at": { "type": "string", "format": "date-time", "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`", "nullable": true }, "cron": { "type": "string", "description": "Frequency of this command schedule, as defined at https://crontab.guru", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "description": "Enter `0` for this parameter." }, "timezone": { "type": "string", "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format." }, "displayTimezone": { "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "description": "You must create a command template before you can schedule this command.", "nullable": true }, "composeOperationId": { "type": "string", "format": "uuid", "description": "Runs theopolis task source.", "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "parameterValue": { "type": "string", "description": "Value of the command parameter to be sent with this scheduled command.", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to which to send this command." }, "status": { "type": "string", "description": "Internal use only, ignore." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/schedules" } }, { "id": "admin.schedules.delete", "method": "DELETE", "pathTemplate": "schedules/{scheduleId}", "stability": "stable", "summary": "Delete a schedule", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ScheduleController.delete", "description": "Delete a command schedule.\nResource: schedules\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/schedules/{id}" } }, { "id": "admin.schedules.get", "method": "GET", "pathTemplate": "schedules/{scheduleId}", "stability": "stable", "summary": "Get a schedule by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ScheduleController.getOne", "description": "Get a command schedule by command schedule ID.\nResource: schedules\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Schedule", "type": "object", "required": [ "name", "description", "type", "durationMs", "timezone", "deviceId", "at", "cron", "commandTemplateId", "parameterValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this new schedule." }, "name": { "type": "string", "description": "Name of this schedule." }, "description": { "type": "string", "description": "User-friendly description of this command schedule." }, "type": { "type": "string", "description": "Enter `command`.", "enum": [ "command", "run-workflow", "generate-insights", "compose-operation" ] }, "at": { "type": "string", "format": "date-time", "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`", "nullable": true }, "cron": { "type": "string", "description": "Frequency of this command schedule, as defined at https://crontab.guru", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "description": "Enter `0` for this parameter." }, "timezone": { "type": "string", "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format." }, "displayTimezone": { "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "description": "You must create a command template before you can schedule this command.", "nullable": true }, "composeOperationId": { "type": "string", "format": "uuid", "description": "Runs theopolis task source.", "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "parameterValue": { "type": "string", "description": "Value of the command parameter to be sent with this scheduled command.", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to which to send this command." }, "status": { "type": "string", "description": "Internal use only, ignore." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/schedules/{id}" } }, { "id": "admin.schedules.query", "method": "POST", "pathTemplate": "schedules/query", "stability": "stable", "summary": "Query schedules", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ScheduleController.query", "description": "Query command schedules for an organization.\nResource: schedules\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SchedulesQuery", "type": "object", "properties": { "organizationId": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "active": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "SchedulesQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ScheduleListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Schedule", "type": "object", "required": [ "name", "description", "type", "durationMs", "timezone", "deviceId", "at", "cron", "commandTemplateId", "parameterValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this new schedule.", "truncated": true }, "name": { "type": "string", "description": "Name of this schedule.", "truncated": true }, "description": { "type": "string", "description": "User-friendly description of this command schedule.", "truncated": true }, "type": { "type": "string", "description": "Enter `command`.", "enum": [ "command", "run-workflow", "generate-insights", "compose-operation" ], "truncated": true }, "at": { "type": "string", "format": "date-time", "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`", "nullable": true, "truncated": true }, "cron": { "type": "string", "description": "Frequency of this command schedule, as defined at https://crontab.guru", "nullable": true, "truncated": true }, "durationMs": { "type": "integer", "format": "int64", "description": "Enter `0` for this parameter.", "truncated": true }, "timezone": { "type": "string", "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format.", "truncated": true }, "displayTimezone": { "nullable": true, "truncated": true }, "commandTemplateId": { "type": "string", "format": "uuid", "description": "You must create a command template before you can schedule this command.", "nullable": true, "truncated": true }, "composeOperationId": { "type": "string", "format": "uuid", "description": "Runs theopolis task source.", "nullable": true, "truncated": true }, "workflowId": { "type": "string", "nullable": true, "truncated": true }, "parameterValue": { "type": "string", "description": "Value of the command parameter to be sent with this scheduled command.", "nullable": true, "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to which to send this command.", "truncated": true }, "status": { "type": "string", "description": "Internal use only, ignore.", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/schedules/query" } }, { "id": "admin.schedules.update", "method": "PATCH", "pathTemplate": "schedules/{scheduleId}", "stability": "stable", "summary": "Update a schedule", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ScheduleController.patch", "description": "Update an existing command schedule.\nResource: schedules\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialSchedule", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this new schedule." }, "name": { "type": "string", "description": "Name of this schedule." }, "description": { "type": "string", "description": "User-friendly description of this command schedule." }, "type": { "type": "string", "description": "Enter `command`.", "enum": [ "command", "run-workflow", "generate-insights", "compose-operation" ] }, "at": { "type": "string", "format": "date-time", "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`", "nullable": true }, "cron": { "type": "string", "description": "Frequency of this command schedule, as defined at https://crontab.guru", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "description": "Enter `0` for this parameter." }, "timezone": { "type": "string", "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format." }, "displayTimezone": { "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "description": "You must create a command template before you can schedule this command.", "nullable": true }, "composeOperationId": { "type": "string", "format": "uuid", "description": "Runs theopolis task source.", "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "parameterValue": { "type": "string", "description": "Value of the command parameter to be sent with this scheduled command.", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to which to send this command." }, "status": { "type": "string", "description": "Internal use only, ignore." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "PartialSchedule", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Schedule", "type": "object", "required": [ "name", "description", "type", "durationMs", "timezone", "deviceId", "at", "cron", "commandTemplateId", "parameterValue" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which you want to add this new schedule." }, "name": { "type": "string", "description": "Name of this schedule." }, "description": { "type": "string", "description": "User-friendly description of this command schedule." }, "type": { "type": "string", "description": "Enter `command`.", "enum": [ "command", "run-workflow", "generate-insights", "compose-operation" ] }, "at": { "type": "string", "format": "date-time", "description": "Timestamp at which this command should execute. Must be in the future. Format: `YYYY-MM-DDTHH:MM:SS`", "nullable": true }, "cron": { "type": "string", "description": "Frequency of this command schedule, as defined at https://crontab.guru", "nullable": true }, "durationMs": { "type": "integer", "format": "int64", "description": "Enter `0` for this parameter." }, "timezone": { "type": "string", "description": "Timezone which corresponds to the timestamp provided in the `at` parameter, in `tz database` format." }, "displayTimezone": { "nullable": true }, "commandTemplateId": { "type": "string", "format": "uuid", "description": "You must create a command template before you can schedule this command.", "nullable": true }, "composeOperationId": { "type": "string", "format": "uuid", "description": "Runs theopolis task source.", "nullable": true }, "workflowId": { "type": "string", "nullable": true }, "parameterValue": { "type": "string", "description": "Value of the command parameter to be sent with this scheduled command.", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device to which to send this command." }, "status": { "type": "string", "description": "Internal use only, ignore." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/schedules/{id}" } }, { "id": "admin.shares.create", "method": "POST", "pathTemplate": "shares", "stability": "stable", "summary": "Create a share", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.shares.delete", "method": "DELETE", "pathTemplate": "shares/{code}", "stability": "stable", "summary": "Delete a share", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ShareController.delete", "description": "Revoke a share\nResource: share\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/shares/{code}" } }, { "id": "admin.shares.get", "method": "GET", "pathTemplate": "shares/{code}", "stability": "stable", "summary": "Get a share", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ShareController.getOne", "description": "Get a share", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Share", "type": "object", "required": [ "scope", "time" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "time": { "type": "string", "format": "date-time" }, "expiration": { "type": "string", "format": "date-time" }, "message": { "type": "string" }, "userName": { "type": "string" }, "channelId": { "type": "string", "format": "uuid" }, "dashboardModuleId": { "type": "string", "format": "uuid", "nullable": true }, "delegateTeleop": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/shares/{code}" } }, { "id": "admin.shares.list", "method": "GET", "pathTemplate": "shares", "stability": "stable", "summary": "List shares", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ShareController.getAll", "description": "List shares\nResource: share\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ShareListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Share", "type": "object", "required": [ "scope", "time" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "userId": { "type": "string", "format": "uuid", "truncated": true }, "code": { "type": "string", "truncated": true }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "truncated": true }, "time": { "type": "string", "format": "date-time", "truncated": true }, "expiration": { "type": "string", "format": "date-time", "truncated": true }, "message": { "type": "string", "truncated": true }, "userName": { "type": "string", "truncated": true }, "channelId": { "type": "string", "format": "uuid", "truncated": true }, "dashboardModuleId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "delegateTeleop": { "type": "boolean", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/shares" } }, { "id": "admin.shares.query", "method": "POST", "pathTemplate": "shares/query", "stability": "stable", "summary": "Query shares", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ShareController.query", "description": "Query a paginated list of shared tokens.\nResource: share\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ShareQuery", "type": "object", "properties": { "hasModule": { "type": "boolean", "description": "Query for shared tokens for modules." }, "count": { "type": "number", "format": "int64", "description": "Limit the number of share tokens returned by this query." }, "offset": { "type": "number", "format": "int64", "description": "Paginate the results by specifying an offset." } } } } }, "contentTypes": [ "application/json" ], "description": "ShareQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ShareListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Share", "type": "object", "required": [ "scope", "time" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "userId": { "type": "string", "format": "uuid", "truncated": true }, "code": { "type": "string", "truncated": true }, "scope": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "nullable": true, "truncated": true }, "time": { "type": "string", "format": "date-time", "truncated": true }, "expiration": { "type": "string", "format": "date-time", "truncated": true }, "message": { "type": "string", "truncated": true }, "userName": { "type": "string", "truncated": true }, "channelId": { "type": "string", "format": "uuid", "truncated": true }, "dashboardModuleId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "delegateTeleop": { "type": "boolean", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/shares/query" } }, { "id": "admin.streams.create", "method": "POST", "pathTemplate": "streams", "stability": "stable", "summary": "Create a stream", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "StreamController.post", "description": "Create a stream\nResource: streams\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Stream", "type": "object", "required": [ "streamName", "streamType" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "streamName": { "type": "string" }, "streamType": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "description": { "type": "string", "nullable": true }, "alias": { "type": "string", "nullable": true }, "isTelemetryFilter": { "type": "boolean" }, "isEventFilter": { "type": "boolean" }, "active": { "type": "boolean" }, "isOverviewColumn": { "type": "boolean" }, "isOverviewRow": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Stream", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Stream", "type": "object", "required": [ "streamName", "streamType" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "streamName": { "type": "string" }, "streamType": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "description": { "type": "string", "nullable": true }, "alias": { "type": "string", "nullable": true }, "isTelemetryFilter": { "type": "boolean" }, "isEventFilter": { "type": "boolean" }, "active": { "type": "boolean" }, "isOverviewColumn": { "type": "boolean" }, "isOverviewRow": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/streams/" } }, { "id": "admin.streams.delete", "method": "DELETE", "pathTemplate": "streams/{streamId}", "stability": "stable", "summary": "Delete a stream", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "StreamController.delete", "description": "Delete a stream\nResource: streams\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/streams/{id}" } }, { "id": "admin.streams.get", "method": "GET", "pathTemplate": "streams/{streamId}", "stability": "stable", "summary": "Get a stream by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "StreamController.getOne", "description": "Get a stream\nResource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Stream", "type": "object", "required": [ "streamName", "streamType" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "streamName": { "type": "string" }, "streamType": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "description": { "type": "string", "nullable": true }, "alias": { "type": "string", "nullable": true }, "isTelemetryFilter": { "type": "boolean" }, "isEventFilter": { "type": "boolean" }, "active": { "type": "boolean" }, "isOverviewColumn": { "type": "boolean" }, "isOverviewRow": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/streams/{id}" } }, { "id": "admin.streams.list", "method": "GET", "pathTemplate": "streams", "stability": "stable", "summary": "List streams", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "StreamController.list", "description": "List streams\nResource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": null, "location": "query", "name": "active", "required": false, "schema": { "type": "boolean" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StreamListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Stream", "type": "object", "required": [ "streamName", "streamType" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "streamName": { "type": "string", "truncated": true }, "streamType": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "alias": { "type": "string", "nullable": true, "truncated": true }, "isTelemetryFilter": { "type": "boolean", "truncated": true }, "isEventFilter": { "type": "boolean", "truncated": true }, "active": { "type": "boolean", "truncated": true }, "isOverviewColumn": { "type": "boolean", "truncated": true }, "isOverviewRow": { "type": "boolean", "truncated": true }, "enabled": { "type": "boolean", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/streams/" } }, { "id": "admin.streams.update", "method": "PATCH", "pathTemplate": "streams/{streamId}", "stability": "stable", "summary": "Update a stream", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "StreamController.patch", "description": "Update a stream\nResource: streams\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialStream", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "streamName": { "type": "string" }, "streamType": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "description": { "type": "string", "nullable": true }, "alias": { "type": "string", "nullable": true }, "isTelemetryFilter": { "type": "boolean" }, "isEventFilter": { "type": "boolean" }, "active": { "type": "boolean" }, "isOverviewColumn": { "type": "boolean" }, "isOverviewRow": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "PartialStream", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Stream", "type": "object", "required": [ "streamName", "streamType" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "streamName": { "type": "string" }, "streamType": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "description": { "type": "string", "nullable": true }, "alias": { "type": "string", "nullable": true }, "isTelemetryFilter": { "type": "boolean" }, "isEventFilter": { "type": "boolean" }, "active": { "type": "boolean" }, "isOverviewColumn": { "type": "boolean" }, "isOverviewRow": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/streams/{id}" } }, { "id": "admin.tag-templates.create", "method": "POST", "pathTemplate": "tag-templates", "stability": "stable", "summary": "Create a tag template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TagTemplateController.post", "description": "Create a new tag template.\nResource: streams\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TagTemplate", "type": "object", "required": [ "tagKey" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which to add this tag template." }, "tagKey": { "description": "Key of this tag template." }, "isGroup": { "type": "boolean", "description": "Is this tag used to create device groups?" }, "isTelemetryFilter": { "type": "boolean", "description": "Is this tag used to filter telemetry data?" }, "isEventFilter": { "type": "boolean", "description": "Is this tag used to filter events?" }, "enabled": { "type": "boolean", "description": "Set this to `false` to delete this tag template." }, "description": { "type": "string", "description": "Description of this tag template.", "nullable": true }, "labelSetId": { "type": "string", "description": "Internal use only, ignore.", "nullable": true }, "labelEnum": { "type": "array", "description": "Internal use only, ignore.", "nullable": true, "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value corresponding to the user-friendly description for this label. This will be passed as the response to this intervention request." }, "displayName": { "type": "string", "description": "User-friendly description of label. This will be presented to the user in a dropdown." }, "description": { "type": "string" } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "TagTemplate", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TagTemplate", "type": "object", "required": [ "tagKey" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which to add this tag template." }, "tagKey": { "description": "Key of this tag template." }, "isGroup": { "type": "boolean", "description": "Is this tag used to create device groups?" }, "isTelemetryFilter": { "type": "boolean", "description": "Is this tag used to filter telemetry data?" }, "isEventFilter": { "type": "boolean", "description": "Is this tag used to filter events?" }, "enabled": { "type": "boolean", "description": "Set this to `false` to delete this tag template." }, "description": { "type": "string", "description": "Description of this tag template.", "nullable": true }, "labelSetId": { "type": "string", "description": "Internal use only, ignore.", "nullable": true }, "labelEnum": { "type": "array", "description": "Internal use only, ignore.", "nullable": true, "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value corresponding to the user-friendly description for this label. This will be passed as the response to this intervention request.", "truncated": true }, "displayName": { "type": "string", "description": "User-friendly description of label. This will be presented to the user in a dropdown.", "truncated": true }, "description": { "type": "string", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/tag-templates" } }, { "id": "admin.tag-templates.delete", "method": "DELETE", "pathTemplate": "tag-templates/{tagTemplateId}", "stability": "stable", "summary": "Delete a tag template", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TagTemplateController.delete", "description": "Delete a tag template.\nResource: streams\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/tag-templates/{id}" } }, { "id": "admin.tag-templates.get", "method": "GET", "pathTemplate": "tag-templates/{tagTemplateId}", "stability": "stable", "summary": "Get a tag template by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TagTemplateController.getOne", "description": "Get a tag template by tag template ID.\nResource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TagTemplate", "type": "object", "required": [ "tagKey" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which to add this tag template." }, "tagKey": { "description": "Key of this tag template." }, "isGroup": { "type": "boolean", "description": "Is this tag used to create device groups?" }, "isTelemetryFilter": { "type": "boolean", "description": "Is this tag used to filter telemetry data?" }, "isEventFilter": { "type": "boolean", "description": "Is this tag used to filter events?" }, "enabled": { "type": "boolean", "description": "Set this to `false` to delete this tag template." }, "description": { "type": "string", "description": "Description of this tag template.", "nullable": true }, "labelSetId": { "type": "string", "description": "Internal use only, ignore.", "nullable": true }, "labelEnum": { "type": "array", "description": "Internal use only, ignore.", "nullable": true, "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value corresponding to the user-friendly description for this label. This will be passed as the response to this intervention request.", "truncated": true }, "displayName": { "type": "string", "description": "User-friendly description of label. This will be presented to the user in a dropdown.", "truncated": true }, "description": { "type": "string", "truncated": true } } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/tag-templates/{id}" } }, { "id": "admin.tag-templates.list", "method": "GET", "pathTemplate": "tag-templates", "stability": "stable", "summary": "List tag templates", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TagTemplateController.list", "description": "List all tag templates in your organization.\nResource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TagTemplateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TagTemplate", "type": "object", "required": [ "tagKey" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which to add this tag template.", "truncated": true }, "tagKey": { "description": "Key of this tag template.", "truncated": true }, "isGroup": { "type": "boolean", "description": "Is this tag used to create device groups?", "truncated": true }, "isTelemetryFilter": { "type": "boolean", "description": "Is this tag used to filter telemetry data?", "truncated": true }, "isEventFilter": { "type": "boolean", "description": "Is this tag used to filter events?", "truncated": true }, "enabled": { "type": "boolean", "description": "Set this to `false` to delete this tag template.", "truncated": true }, "description": { "type": "string", "description": "Description of this tag template.", "nullable": true, "truncated": true }, "labelSetId": { "type": "string", "description": "Internal use only, ignore.", "nullable": true, "truncated": true }, "labelEnum": { "type": "array", "description": "Internal use only, ignore.", "nullable": true, "items": { "ref": "#/components/schemas/Label", "type": "object", "required": [ "value" ], "truncated": true }, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/tag-templates" } }, { "id": "admin.tag-templates.update", "method": "PATCH", "pathTemplate": "tag-templates/{tagTemplateId}", "stability": "stable", "summary": "Update a tag template", "target": "admin", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "admin.task-summaries.batch.create", "method": "POST", "pathTemplate": "task-summaries/batch", "stability": "stable", "summary": "Create task summaries in batch", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TaskSummaryController.batch", "description": "Create multiple task summaries with a single endpoint call.\nResource: taskSummaries\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskSummaryBatchRequest", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskSummary", "type": "object", "required": [ "taskSummaryFormatId", "report", "taskId", "generatedAt", "time" ], "properties": { "type": { "type": "string", "description": "Enter `task-summary`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "taskSummaryFormatId": { "type": "string", "format": "uuid", "description": "ID of the task summary format which describes this task summary." }, "report": { "type": "object", "description": "Enter the data for this task summary in key-value pairs, as described by the task summary format." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "taskId": { "type": "string", "description": "Enter a unique identifier to identify this task summary." }, "generatedAt": { "type": "string", "format": "date-time", "description": "Enter a start time for when this event occurred. This differs from `createdAt`, which is automatically populated when the task summary is created." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string", "truncated": true } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string", "truncated": true } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive).", "truncated": true }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive).", "truncated": true } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } }, "ignoreDuplicates": { "type": "boolean" }, "withoutDeviceTags": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "TaskSummaryBatchRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/task-summaries/batch" } }, { "id": "admin.task-summaries.create", "method": "POST", "pathTemplate": "task-summaries", "stability": "stable", "summary": "Create a task summary", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TaskSummaryController.post", "description": "Create a new task summary. Before you can create a task summary, you must first create a task summary format.\nResource: taskSummaries\nAuthorized roles: operator, device", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskSummary", "type": "object", "required": [ "taskSummaryFormatId", "report", "taskId", "generatedAt", "time" ], "properties": { "type": { "type": "string", "description": "Enter `task-summary`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "taskSummaryFormatId": { "type": "string", "format": "uuid", "description": "ID of the task summary format which describes this task summary." }, "report": { "type": "object", "description": "Enter the data for this task summary in key-value pairs, as described by the task summary format." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "taskId": { "type": "string", "description": "Enter a unique identifier to identify this task summary." }, "generatedAt": { "type": "string", "format": "date-time", "description": "Enter a start time for when this event occurred. This differs from `createdAt`, which is automatically populated when the task summary is created." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "TaskSummary", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskSummary", "type": "object", "required": [ "taskSummaryFormatId", "report", "taskId", "generatedAt", "time" ], "properties": { "type": { "type": "string", "description": "Enter `task-summary`.", "enum": [ "triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "intervention-response", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation", "task-summary", "stateful" ] }, "taskSummaryFormatId": { "type": "string", "format": "uuid", "description": "ID of the task summary format which describes this task summary." }, "report": { "type": "object", "description": "Enter the data for this task summary in key-value pairs, as described by the task summary format." }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the data range relevant to this event.", "nullable": true }, "taskId": { "type": "string", "description": "Enter a unique identifier to identify this task summary." }, "generatedAt": { "type": "string", "format": "date-time", "description": "Enter a start time for when this event occurred. This differs from `createdAt`, which is automatically populated when the task summary is created." }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new event." }, "externalId": { "type": "string", "description": "External ID of this event.", "nullable": true }, "userId": { "type": "string", "format": "uuid", "description": "User ID associated with this event.", "nullable": true }, "time": { "type": "string", "format": "date-time", "description": "Start time of the data range relevant to this event." }, "parentId": { "type": "string", "format": "uuid", "description": "If this custom event is related to another event, you can add the ID of that parent event here.", "nullable": true }, "metadata": { "type": "object", "description": "User-customizable metadata associated with this event in key-value pair format.", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "Message of this event. Must match the `message` field in the Formant UI when configuring a custom event." }, "viewed": { "type": "boolean" }, "deviceId": { "type": "string", "format": "uuid", "description": "ID of the device relevant to this event.", "nullable": true }, "streamName": { "type": "string", "nullable": true }, "streamType": { "type": "string", "nullable": true, "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "notificationEnabled": { "type": "boolean", "description": "Set this to `true` to enable notifications for this event." }, "notificationMuted": { "ref": "#/components/schemas/NotificationMuted", "type": "object", "description": "Set this to temporarily mute notifications for this event.", "nullable": true, "required": [ "start", "end" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Mute start time (inclusive)." }, "end": { "type": "string", "format": "date-time", "description": "Mute end time (exclusive)." } } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/task-summaries/" } }, { "id": "admin.task-summaries.delete", "method": "DELETE", "pathTemplate": "task-summaries/{taskSummaryId}", "stability": "stable", "summary": "Delete a task summary", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TaskSummaryController.delete", "description": "Delete a task summary.\nResource: taskSummaries\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/task-summaries/{id}" } }, { "id": "admin.task-summary-formats.create", "method": "POST", "pathTemplate": "task-summary-formats", "stability": "stable", "summary": "Create a task summary format", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TaskSummaryFormatController.post", "description": "Create a new task summary format.\nResource: taskSummaries\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskSummaryFormat", "type": "object", "required": [ "label", "format" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new task summary format." }, "label": { "type": "string", "description": "User-friendly name for this task summary format." }, "format": { "type": "object", "description": "Enter the data structure for this task summary format in key-value pairs." }, "deletedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "TaskSummaryFormat", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskSummaryFormat", "type": "object", "required": [ "label", "format" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new task summary format." }, "label": { "type": "string", "description": "User-friendly name for this task summary format." }, "format": { "type": "object", "description": "Enter the data structure for this task summary format in key-value pairs." }, "deletedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/task-summary-formats/" } }, { "id": "admin.task-summary-formats.list", "method": "GET", "pathTemplate": "task-summary-formats", "stability": "stable", "summary": "List task summary formats", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TaskSummaryFormatController.list", "description": "List all task summary formats in your organization.\nResource: taskSummaries\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskSummaryFormatListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskSummaryFormat", "type": "object", "required": [ "label", "format" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization in which to create this new task summary format.", "truncated": true }, "label": { "type": "string", "description": "User-friendly name for this task summary format.", "truncated": true }, "format": { "type": "object", "description": "Enter the data structure for this task summary format in key-value pairs.", "truncated": true }, "deletedAt": { "type": "string", "format": "date-time", "description": "Internal use only, ignore.", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/task-summary-formats/" } }, { "id": "admin.teams.create", "method": "POST", "pathTemplate": "teams", "stability": "stable", "summary": "Create a team", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeamController.post", "description": "Create a team\nResource: users\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Team", "type": "object", "required": [ "name", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this team belongs." }, "name": { "type": "string", "description": "Name of this team." }, "roleId": { "type": "string", "format": "uuid", "description": "ID of the role which will be assigned to all members of this team." }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "roles": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Roles to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "users": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Users to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "teams": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Teams to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "devices": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Devices to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "fleets": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Fleets to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "events": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Events to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Views to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "keyValue": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "keyValue entries to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "Team", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Team", "type": "object", "required": [ "name", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this team belongs." }, "name": { "type": "string", "description": "Name of this team." }, "roleId": { "type": "string", "format": "uuid", "description": "ID of the role which will be assigned to all members of this team." }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "roles": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Roles to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "users": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Users to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "teams": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Teams to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "devices": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Devices to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "fleets": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Fleets to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "events": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Events to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Views to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "keyValue": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "keyValue entries to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teams" } }, { "id": "admin.teams.delete", "method": "DELETE", "pathTemplate": "teams/{teamId}", "stability": "stable", "summary": "Delete a team", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeamController.delete", "description": "Delete a team\nResource: users\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teams/{id}" } }, { "id": "admin.teams.get", "method": "GET", "pathTemplate": "teams/{teamId}", "stability": "stable", "summary": "Get a team by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeamController.getOne", "description": "Resource: users\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Team", "type": "object", "required": [ "name", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this team belongs." }, "name": { "type": "string", "description": "Name of this team." }, "roleId": { "type": "string", "format": "uuid", "description": "ID of the role which will be assigned to all members of this team." }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "roles": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Roles to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "users": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Users to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "teams": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Teams to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "devices": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Devices to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "fleets": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Fleets to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "events": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Events to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Views to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "keyValue": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "keyValue entries to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teams/{id}" } }, { "id": "admin.teams.list", "method": "GET", "pathTemplate": "teams", "stability": "stable", "summary": "List teams", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeamController.list", "description": "List teams\nResource: users\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TeamListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Team", "type": "object", "required": [ "name", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this team belongs.", "truncated": true }, "name": { "type": "string", "description": "Name of this team.", "truncated": true }, "roleId": { "type": "string", "format": "uuid", "description": "ID of the role which will be assigned to all members of this team.", "truncated": true }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true, "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teams/" } }, { "id": "admin.teams.update", "method": "PATCH", "pathTemplate": "teams/{teamId}", "stability": "stable", "summary": "Update a team", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeamController.patch", "description": "Update a team\nResource: users\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialTeam", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this team belongs." }, "name": { "type": "string", "description": "Name of this team." }, "roleId": { "type": "string", "format": "uuid", "description": "ID of the role which will be assigned to all members of this team." }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "roles": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Roles to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "users": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Users to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "teams": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Teams to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "devices": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Devices to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "fleets": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Fleets to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "events": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Events to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Views to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "keyValue": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "keyValue entries to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "PartialTeam", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Team", "type": "object", "required": [ "name", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this team belongs." }, "name": { "type": "string", "description": "Name of this team." }, "roleId": { "type": "string", "format": "uuid", "description": "ID of the role which will be assigned to all members of this team." }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "Currently unused, ignore.", "nullable": true, "properties": { "roles": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Roles to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "users": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Users to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "teams": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Teams to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "devices": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Devices to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "fleets": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Fleets to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "events": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Events to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Views to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "keyValue": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "keyValue entries to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teams/{id}" } }, { "id": "admin.teams.users.list", "method": "GET", "pathTemplate": "teams/{teamId}/users", "stability": "stable", "summary": "List users in a team", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeamController.getUsers", "description": "Resource: users\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UserListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/User", "type": "object", "required": [ "email", "firstName", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs.", "truncated": true }, "accountId": { "type": "string", "format": "uuid", "description": "ID of the account to which this user belongs.", "nullable": true, "truncated": true }, "roleId": { "type": "string", "format": "uuid", "description": "ID of this user's role.", "nullable": true, "truncated": true }, "email": { "type": "string", "format": "email", "description": "Email address of this user.", "truncated": true }, "externalUserId": { "type": "string", "description": "Ignore this - for internal use only.", "nullable": true, "truncated": true }, "firstName": { "type": "string", "description": "First name of this user.", "truncated": true }, "lastName": { "type": "string", "description": "Last name of this user.", "truncated": true }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "", "nullable": true, "truncated": true }, "teamId": { "type": "string", "format": "uuid", "description": "ID of the team to which this user belongs.", "nullable": true, "truncated": true }, "phoneNumber": { "type": "string", "description": "User's phone number (e.g., +14155550100).", "truncated": true }, "enabled": { "type": "boolean", "description": "Enable or disable this user. Set this to False to delete this user.", "truncated": true }, "isOrganizationOwner": { "type": "boolean", "description": "Should this user have organization owner privileges?", "truncated": true }, "termsAccepted": { "type": "string", "description": "Has this user accepted Formant terms and conditions?", "truncated": true }, "lastLoggedIn": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "passwordHash": { "type": "string", "nullable": true, "truncated": true }, "isSingleSignOn": { "type": "boolean", "truncated": true }, "smsOptInStatus": { "type": "string", "nullable": true, "enum": [ "OPT_IN", "OPT_OUT" ], "truncated": true }, "region": { "type": "string", "enum": [ "AMER", "EMEA", "JAPAC" ], "truncated": true }, "isServiceAccount": { "type": "boolean", "truncated": true }, "allowCustomEmailConfiguration": { "type": "boolean", "truncated": true }, "jobTitle": { "type": "string", "truncated": true }, "language": { "type": "string", "enum": [ "en-US", "fr-CA" ], "truncated": true }, "units": { "type": "string", "enum": [ "metric", "imperial" ], "truncated": true }, "timezone": { "type": "string", "truncated": true }, "title": { "type": "string", "description": "Title for the user.", "nullable": true, "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "metadata": { "nullable": true, "truncated": true }, "grants": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teams/{id}/users" } }, { "id": "admin.teleop-views.create", "method": "POST", "pathTemplate": "teleop-views", "stability": "stable", "summary": "Create a teleop view", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeleopViewController.create", "description": "Create a teleop view\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TeleopView", "type": "object", "required": [ "name", "configuration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "TeleopView", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TeleopView", "type": "object", "required": [ "name", "configuration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teleop-views" } }, { "id": "admin.teleop-views.delete", "method": "DELETE", "pathTemplate": "teleop-views/{teleopViewId}", "stability": "stable", "summary": "Delete a teleop view", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeleopViewController.delete", "description": "Delete a teleop view\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teleop-views/{id}" } }, { "id": "admin.teleop-views.get", "method": "GET", "pathTemplate": "teleop-views/{teleopViewId}", "stability": "stable", "summary": "Get a teleop view by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeleopViewController.getOne", "description": "Get a teleop view\nResource: views\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TeleopView", "type": "object", "required": [ "name", "configuration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teleop-views/{id}" } }, { "id": "admin.teleop-views.list", "method": "GET", "pathTemplate": "teleop-views", "stability": "stable", "summary": "List teleop views", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeleopViewController.getAll", "description": "List all teleop views\nResource: views\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TeleopViewListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TeleopView", "type": "object", "required": [ "name", "configuration" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "configuration": { "type": "object", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teleop-views" } }, { "id": "admin.teleop-views.update", "method": "PATCH", "pathTemplate": "teleop-views/{teleopViewId}", "stability": "stable", "summary": "Update a teleop view", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "TeleopViewController.update", "description": "Update a teleop view\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialTeleopView", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialTeleopView", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TeleopView", "type": "object", "required": [ "name", "configuration" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/teleop-views/{id}" } }, { "id": "admin.users.get", "method": "GET", "pathTemplate": "users/{userId}", "stability": "stable", "summary": "Get a user by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "UserController.getOne", "description": "Get a user by ID.\nResource: users\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/User", "type": "object", "required": [ "email", "firstName", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs." }, "accountId": { "type": "string", "format": "uuid", "description": "ID of the account to which this user belongs.", "nullable": true }, "roleId": { "type": "string", "format": "uuid", "description": "ID of this user's role.", "nullable": true }, "email": { "type": "string", "format": "email", "description": "Email address of this user." }, "externalUserId": { "type": "string", "description": "Ignore this - for internal use only.", "nullable": true }, "firstName": { "type": "string", "description": "First name of this user." }, "lastName": { "type": "string", "description": "Last name of this user." }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "", "nullable": true, "properties": { "roles": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Roles to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "users": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Users to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "teams": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Teams to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "devices": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Devices to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "fleets": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Fleets to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "events": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Events to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "views": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "Views to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "keyValue": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "description": "keyValue entries to which a user with this scope has access.", "nullable": true, "properties": { "start": { "type": "string", "format": "date-time", "truncated": true }, "end": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "truncated": true }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "names": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "truncated": true }, "notTags": { "type": "object", "truncated": true }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true } } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "teamId": { "type": "string", "format": "uuid", "description": "ID of the team to which this user belongs.", "nullable": true }, "phoneNumber": { "type": "string", "description": "User's phone number (e.g., +14155550100)." }, "enabled": { "type": "boolean", "description": "Enable or disable this user. Set this to False to delete this user." }, "isOrganizationOwner": { "type": "boolean", "description": "Should this user have organization owner privileges?" }, "termsAccepted": { "type": "string", "description": "Has this user accepted Formant terms and conditions?" }, "lastLoggedIn": { "type": "string", "format": "date-time", "nullable": true }, "passwordHash": { "type": "string", "nullable": true }, "isSingleSignOn": { "type": "boolean" }, "smsOptInStatus": { "type": "string", "nullable": true, "enum": [ "OPT_IN", "OPT_OUT" ] }, "region": { "type": "string", "enum": [ "AMER", "EMEA", "JAPAC" ] }, "isServiceAccount": { "type": "boolean" }, "allowCustomEmailConfiguration": { "type": "boolean" }, "jobTitle": { "type": "string" }, "language": { "type": "string", "enum": [ "en-US", "fr-CA" ] }, "units": { "type": "string", "enum": [ "metric", "imperial" ] }, "timezone": { "type": "string" }, "title": { "type": "string", "description": "Title for the user.", "nullable": true }, "description": { "type": "string", "nullable": true }, "metadata": { "nullable": true }, "grants": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/users/{id}" } }, { "id": "admin.users.list", "method": "GET", "pathTemplate": "users", "stability": "stable", "summary": "List users", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "UserController.getAll", "description": "List all users in your organization.\nResource: users\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UserListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/User", "type": "object", "required": [ "email", "firstName", "roleId" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "description": "ID of the organization to which this user belongs.", "truncated": true }, "accountId": { "type": "string", "format": "uuid", "description": "ID of the account to which this user belongs.", "nullable": true, "truncated": true }, "roleId": { "type": "string", "format": "uuid", "description": "ID of this user's role.", "nullable": true, "truncated": true }, "email": { "type": "string", "format": "email", "description": "Email address of this user.", "truncated": true }, "externalUserId": { "type": "string", "description": "Ignore this - for internal use only.", "nullable": true, "truncated": true }, "firstName": { "type": "string", "description": "First name of this user.", "truncated": true }, "lastName": { "type": "string", "description": "Last name of this user.", "truncated": true }, "scope": { "ref": "#/components/schemas/UserScope", "type": "object", "description": "", "nullable": true, "truncated": true }, "teamId": { "type": "string", "format": "uuid", "description": "ID of the team to which this user belongs.", "nullable": true, "truncated": true }, "phoneNumber": { "type": "string", "description": "User's phone number (e.g., +14155550100).", "truncated": true }, "enabled": { "type": "boolean", "description": "Enable or disable this user. Set this to False to delete this user.", "truncated": true }, "isOrganizationOwner": { "type": "boolean", "description": "Should this user have organization owner privileges?", "truncated": true }, "termsAccepted": { "type": "string", "description": "Has this user accepted Formant terms and conditions?", "truncated": true }, "lastLoggedIn": { "type": "string", "format": "date-time", "nullable": true, "truncated": true }, "passwordHash": { "type": "string", "nullable": true, "truncated": true }, "isSingleSignOn": { "type": "boolean", "truncated": true }, "smsOptInStatus": { "type": "string", "nullable": true, "enum": [ "OPT_IN", "OPT_OUT" ], "truncated": true }, "region": { "type": "string", "enum": [ "AMER", "EMEA", "JAPAC" ], "truncated": true }, "isServiceAccount": { "type": "boolean", "truncated": true }, "allowCustomEmailConfiguration": { "type": "boolean", "truncated": true }, "jobTitle": { "type": "string", "truncated": true }, "language": { "type": "string", "enum": [ "en-US", "fr-CA" ], "truncated": true }, "units": { "type": "string", "enum": [ "metric", "imperial" ], "truncated": true }, "timezone": { "type": "string", "truncated": true }, "title": { "type": "string", "description": "Title for the user.", "nullable": true, "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "metadata": { "nullable": true, "truncated": true }, "grants": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/users" } }, { "id": "admin.views.create", "method": "POST", "pathTemplate": "views", "stability": "stable", "summary": "Create a view", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ViewController.post", "description": "Create a view\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/View", "type": "object", "required": [ "name", "layout", "configuration", "index", "filter", "deviceFilter", "groupFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "showOnSingleDevice": { "type": "boolean" }, "showOnMultiDevice": { "type": "boolean" }, "showOnTeleop": { "type": "boolean" }, "showTimeline": { "type": "boolean" }, "localModeEnabled": { "type": "boolean" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "groupFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "layout": { "type": "object" }, "layoutType": { "type": "string", "nullable": true, "enum": [ "dashboard", "observe", "fullscreen", "analytics", "teleop" ] }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string" }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "configuration": { "oneOf": [ { "ref": "#/components/schemas/BitsetViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/ImageViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocalizationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/PointCloudViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/TransformTreeViewConfiguration", "type": "object", "truncated": true } ] } } } }, "smartFleetId": { "type": "string", "format": "uuid", "nullable": true }, "index": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "View", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/View", "type": "object", "required": [ "name", "layout", "configuration", "index", "filter", "deviceFilter", "groupFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "showOnSingleDevice": { "type": "boolean" }, "showOnMultiDevice": { "type": "boolean" }, "showOnTeleop": { "type": "boolean" }, "showTimeline": { "type": "boolean" }, "localModeEnabled": { "type": "boolean" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "groupFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "layout": { "type": "object" }, "layoutType": { "type": "string", "nullable": true, "enum": [ "dashboard", "observe", "fullscreen", "analytics", "teleop" ] }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "configuration": { "type": "object", "truncated": true } } } }, "smartFleetId": { "type": "string", "format": "uuid", "nullable": true }, "index": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "201" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/views" } }, { "id": "admin.views.delete", "method": "DELETE", "pathTemplate": "views/{viewId}", "stability": "stable", "summary": "Delete a view", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ViewController.delete", "description": "Delete a view\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/views/{id}" } }, { "id": "admin.views.get", "method": "GET", "pathTemplate": "views/{viewId}", "stability": "stable", "summary": "Get a view by id", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ViewController.getOne", "description": "Get a device layout\nResource: views\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/View", "type": "object", "required": [ "name", "layout", "configuration", "index", "filter", "deviceFilter", "groupFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "showOnSingleDevice": { "type": "boolean" }, "showOnMultiDevice": { "type": "boolean" }, "showOnTeleop": { "type": "boolean" }, "showTimeline": { "type": "boolean" }, "localModeEnabled": { "type": "boolean" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "groupFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "layout": { "type": "object" }, "layoutType": { "type": "string", "nullable": true, "enum": [ "dashboard", "observe", "fullscreen", "analytics", "teleop" ] }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "configuration": { "type": "object", "truncated": true } } } }, "smartFleetId": { "type": "string", "format": "uuid", "nullable": true }, "index": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/views/{id}" } }, { "id": "admin.views.list", "method": "GET", "pathTemplate": "views", "stability": "stable", "summary": "List views", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ViewController.getAll", "description": "List all device layouts\nResource: views\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ViewListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/View", "type": "object", "required": [ "name", "layout", "configuration", "index", "filter", "deviceFilter", "groupFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "url": { "type": "string", "nullable": true, "truncated": true }, "showOnSingleDevice": { "type": "boolean", "truncated": true }, "showOnMultiDevice": { "type": "boolean", "truncated": true }, "showOnTeleop": { "type": "boolean", "truncated": true }, "showTimeline": { "type": "boolean", "truncated": true }, "localModeEnabled": { "type": "boolean", "truncated": true }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "truncated": true }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "truncated": true }, "groupFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "truncated": true }, "layout": { "type": "object", "truncated": true }, "layoutType": { "type": "string", "nullable": true, "enum": [ "dashboard", "observe", "fullscreen", "analytics", "teleop" ], "truncated": true }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "truncated": true }, "truncated": true }, "smartFleetId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "index": { "type": "integer", "format": "int64", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/views" } }, { "id": "admin.views.reorder", "method": "POST", "pathTemplate": "views/reorder", "stability": "stable", "summary": "Reorder views in batch", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ViewController.reorder", "description": "Reorder multiple views\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ReorderRequest", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/ReorderRequestItem", "type": "object", "required": [ "id", "index" ], "properties": { "id": { "type": "string", "format": "uuid" }, "index": { "type": "integer", "format": "int64" } } } } } } } }, "contentTypes": [ "application/json" ], "description": "ReorderRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": null } }, "contentTypes": [ "application/json" ], "description": "Successful response", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/views/reorder" } }, { "id": "admin.views.update", "method": "PATCH", "pathTemplate": "views/{viewId}", "stability": "stable", "summary": "Update a view", "target": "admin", "openapi": { "matched": true, "openapiOperationId": "ViewController.patch", "description": "Update a device layout\nResource: views\nAuthorized roles: administrator", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PartialView", "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "showOnSingleDevice": { "type": "boolean" }, "showOnMultiDevice": { "type": "boolean" }, "showOnTeleop": { "type": "boolean" }, "showTimeline": { "type": "boolean" }, "localModeEnabled": { "type": "boolean" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "groupFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] } } }, "layout": { "type": "object" }, "layoutType": { "type": "string", "nullable": true, "enum": [ "dashboard", "observe", "fullscreen", "analytics", "teleop" ] }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string" }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "configuration": { "oneOf": [ { "ref": "#/components/schemas/BitsetViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/ImageViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/NumericViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/LocalizationViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/PointCloudViewConfiguration", "type": "object", "truncated": true }, { "ref": "#/components/schemas/TransformTreeViewConfiguration", "type": "object", "truncated": true } ] } } } }, "smartFleetId": { "type": "string", "format": "uuid", "nullable": true }, "index": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "PartialView", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/View", "type": "object", "required": [ "name", "layout", "configuration", "index", "filter", "deviceFilter", "groupFilter" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "showOnSingleDevice": { "type": "boolean" }, "showOnMultiDevice": { "type": "boolean" }, "showOnTeleop": { "type": "boolean" }, "showTimeline": { "type": "boolean" }, "localModeEnabled": { "type": "boolean" }, "filter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "deviceFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "groupFilter": { "ref": "#/components/schemas/Filter", "type": "object", "nullable": true, "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "names": { "type": "array", "items": { "type": "string", "truncated": true } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string", "truncated": true } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid", "truncated": true } }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true }, "truncated": true }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } ] } } }, "layout": { "type": "object" }, "layoutType": { "type": "string", "nullable": true, "enum": [ "dashboard", "observe", "fullscreen", "analytics", "teleop" ] }, "configuration": { "type": "array", "items": { "ref": "#/components/schemas/ViewConfiguration", "type": "object", "required": [ "streamName", "type", "configuration" ], "properties": { "streamName": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "configuration": { "type": "object", "truncated": true } } } }, "smartFleetId": { "type": "string", "format": "uuid", "nullable": true }, "index": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/admin.json", "sourcePath": "/views/{id}" } }, { "id": "gateway.ai-integrations.create", "method": "POST", "pathTemplate": "ai-integrations", "stability": "stable", "summary": "Create an AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.delete", "method": "DELETE", "pathTemplate": "ai-integrations/{integrationId}", "stability": "stable", "summary": "Delete an AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.get", "method": "GET", "pathTemplate": "ai-integrations/{integrationId}", "stability": "stable", "summary": "Get an AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.list", "method": "GET", "pathTemplate": "ai-integrations", "stability": "stable", "summary": "List AI integrations", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.connect", "method": "POST", "pathTemplate": "ai-integrations/org/{integrationId}/connect", "stability": "stable", "summary": "Connect organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.create", "method": "POST", "pathTemplate": "ai-integrations/org/", "stability": "stable", "summary": "Create organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.delete", "method": "DELETE", "pathTemplate": "ai-integrations/org/{integrationId}", "stability": "stable", "summary": "Delete organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.disconnect", "method": "POST", "pathTemplate": "ai-integrations/org/{integrationId}/disconnect", "stability": "stable", "summary": "Disconnect organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.list", "method": "GET", "pathTemplate": "ai-integrations/org", "stability": "stable", "summary": "List organization AI integrations", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.tools.list", "method": "GET", "pathTemplate": "ai-integrations/org/{integrationId}/tools", "stability": "stable", "summary": "List tools for organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.tools.update", "method": "PATCH", "pathTemplate": "ai-integrations/org/{integrationId}/tools/{toolName}", "stability": "stable", "summary": "Update tool settings for organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.org.update", "method": "PATCH", "pathTemplate": "ai-integrations/org/{integrationId}", "stability": "stable", "summary": "Update organization AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.update", "method": "PATCH", "pathTemplate": "ai-integrations/{integrationId}", "stability": "stable", "summary": "Update an AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.connect", "method": "POST", "pathTemplate": "ai-integrations/user/{integrationId}/connect", "stability": "stable", "summary": "Connect user AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.disconnect", "method": "POST", "pathTemplate": "ai-integrations/user/{integrationId}/disconnect", "stability": "stable", "summary": "Disconnect user AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.list", "method": "GET", "pathTemplate": "ai-integrations/user", "stability": "stable", "summary": "List user AI integrations", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.tools.all.list", "method": "GET", "pathTemplate": "ai-integrations/user/tools", "stability": "stable", "summary": "List all user AI integration tools", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.tools.call", "method": "POST", "pathTemplate": "ai-integrations/user/{integrationId}/tools/{toolName}/call", "stability": "stable", "summary": "Call a user AI integration tool", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.tools.list", "method": "GET", "pathTemplate": "ai-integrations/user/{integrationId}/tools", "stability": "stable", "summary": "List tools for user AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.tools.update", "method": "PATCH", "pathTemplate": "ai-integrations/user/{integrationId}/tools/{toolName}", "stability": "stable", "summary": "Update tool settings for user AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.ai-integrations.user.update", "method": "PATCH", "pathTemplate": "ai-integrations/user/{integrationId}", "stability": "stable", "summary": "Update user AI integration", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.create", "method": "POST", "pathTemplate": "gateway/", "stability": "stable", "summary": "Create a gateway", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.delete", "method": "DELETE", "pathTemplate": "gateway/{gatewayId}", "stability": "stable", "summary": "Delete a gateway", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.get", "method": "GET", "pathTemplate": "gateway/{gatewayId}", "stability": "stable", "summary": "Get a gateway", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.list", "method": "GET", "pathTemplate": "gateway/", "stability": "stable", "summary": "List gateways", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.token.clear", "method": "DELETE", "pathTemplate": "gateway/{gatewayId}/token", "stability": "stable", "summary": "Clear gateway token", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.token.get", "method": "GET", "pathTemplate": "gateway/{gatewayId}/token", "stability": "stable", "summary": "Get gateway token", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.tools.call", "method": "POST", "pathTemplate": "gateway/{gatewayId}/mcp/tool/{toolName}", "stability": "stable", "summary": "Call a gateway MCP tool", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.tools.list", "method": "GET", "pathTemplate": "gateway/{gatewayId}/mcp/tool/", "stability": "stable", "summary": "List gateway MCP tools", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.gateways.update", "method": "PUT", "pathTemplate": "gateway/{gatewayId}", "stability": "stable", "summary": "Update a gateway", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.mcp.external.metadata.get", "method": "POST", "pathTemplate": "mcp/external/metadata", "stability": "stable", "summary": "Fetch MCP metadata for external URL", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.graph-settings.delete", "method": "DELETE", "pathTemplate": "personas/graph-settings/{personaId}", "stability": "stable", "summary": "Delete persona graph settings", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.graph-settings.get", "method": "GET", "pathTemplate": "personas/graph-settings/{personaId}", "stability": "stable", "summary": "Get persona graph settings", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.graph-settings.upsert", "method": "PUT", "pathTemplate": "personas/graph-settings/{personaId}", "stability": "stable", "summary": "Upsert persona graph settings", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.org.create", "method": "POST", "pathTemplate": "personas/org", "stability": "stable", "summary": "Create organization persona", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.org.delete", "method": "DELETE", "pathTemplate": "personas/org/{personaId}", "stability": "stable", "summary": "Delete organization persona", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.org.get", "method": "GET", "pathTemplate": "personas/org/{personaId}", "stability": "stable", "summary": "Get organization persona", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.org.list", "method": "GET", "pathTemplate": "personas/org", "stability": "stable", "summary": "List organization personas", "target": "gateway", "openapi": { "matched": true, "openapiOperationId": "getPersonas", "description": "Get list of personas for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/PersonaApiResponse", "type": "object", "description": "Raw API response format", "properties": { "personaId": { "type": "string", "truncated": true }, "name": { "type": "string", "truncated": true }, "instructions": { "type": "string", "truncated": true }, "auxInstructions": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true }, "enabled": { "type": "boolean", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of personas", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/gateway.json", "sourcePath": "/personas/org" } }, { "id": "gateway.personas.org.query", "method": "POST", "pathTemplate": "personas/org/query", "stability": "stable", "summary": "Query organization personas", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.org.update", "method": "PATCH", "pathTemplate": "personas/org/{personaId}", "stability": "stable", "summary": "Update organization persona", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.user.get", "method": "GET", "pathTemplate": "personas/user/{personaId}", "stability": "stable", "summary": "Get a user persona", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "gateway.personas.user.tools.call", "method": "POST", "pathTemplate": "personas/user/{personaId}/tools/{toolName}/call", "stability": "stable", "summary": "Call a persona user tool", "target": "gateway", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "ingest.batch.create", "method": "POST", "pathTemplate": "batch", "stability": "stable", "summary": "Ingest telemetry datapoints in batch", "target": "ingest", "openapi": { "matched": true, "openapiOperationId": "batchIngest", "description": "Ingest multiple telemetry data points in a single request. Supports numeric, text, JSON, image, video, bitset, and health streams.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/IngestBatchRequest", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/IngestStreamData", "type": "object", "required": [ "deviceId", "name", "type", "tags", "points" ], "properties": { "deviceId": { "type": "string", "description": "Target device ID" }, "name": { "type": "string", "description": "Stream name" }, "type": { "type": "string", "description": "Stream data type", "enum": [ "numeric", "text", "json", "image", "video", "bitset", "health" ] }, "tags": { "type": "object", "description": "Stream tags", "additionalProperties": { "type": "string", "truncated": true } }, "points": { "type": "array", "description": "Array of [timestamp, value] tuples", "items": { "type": "array", "items": { "type": "object", "truncated": true }, "truncated": true } } } } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": {}, "contentTypes": [], "description": "Data ingested successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "message": { "type": "string", "description": "Error message" }, "code": { "type": "string", "description": "Error code" } } } } }, "contentTypes": [ "application/json" ], "description": "Invalid data format", "statusCode": "400" } ], "sourceFile": "contracts/openapi/ingest.json", "sourcePath": "/ingest/batch" } }, { "id": "query.analytics.aggregates", "method": "POST", "pathTemplate": "analytics/aggregates", "stability": "stable", "summary": "Run analytics aggregate queries", "target": "query", "openapi": { "matched": true, "openapiOperationId": "AnalyticsController.listAggregates", "description": "Will Execute Aggregates Analytics Queries\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "contentTypes": [ "application/json" ], "description": "", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SqlResult", "type": "object", "required": [ "rows", "columns", "rowCount", "sqlText" ], "properties": { "rows": { "type": "array", "items": { "type": "object" } }, "columns": { "type": "array", "items": { "ref": "#/components/schemas/SqlColumn", "type": "object", "required": [ "name", "dataType", "isNullable", "tableName" ], "properties": { "name": { "type": "string", "truncated": true }, "dataType": { "type": "string", "truncated": true }, "isNullable": { "type": "boolean", "truncated": true }, "tableName": { "type": "string", "truncated": true }, "nativeType": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true } } } }, "rowCount": { "type": "number" }, "sqlText": { "type": "string" }, "unit": { "type": "string" }, "autoAnalytics": { "description": "Auto analytics insights" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/analytics/aggregates" } }, { "id": "query.analytics.automated-insights", "method": "POST", "pathTemplate": "analytics/automated-insights", "stability": "stable", "summary": "Generate automated analytics insights", "target": "query", "openapi": { "matched": true, "openapiOperationId": "AnalyticsController.listAutomatedInsights", "description": "Will Execute Automatic Analytics\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SqlQuery", "type": "object", "properties": { "sqlQuery": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "limit": { "type": "number" }, "tableColumns": { "type": "array", "items": { "type": "object" } }, "aggregateLevel": { "type": "string", "nullable": true, "enum": [ "minute", "hour", "date", "day", "week", "month", "year" ] }, "aggregateType": { "type": "string", "enum": [ "avg", "sum", "count", "min", "max", "median", "std_dev" ] }, "orderByColumn": { "type": "string" }, "orderByDescending": { "type": "boolean" }, "groupByDevice": { "type": "boolean" }, "timeDimension": { "type": "boolean" }, "type": { "type": "string" }, "fillGaps": { "type": "boolean" }, "unit": { "type": "string" }, "timezone": { "type": "string" }, "accountId": { "type": "string" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "SqlQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SqlResult", "type": "object", "required": [ "rows", "columns", "rowCount", "sqlText" ], "properties": { "rows": { "type": "array", "items": { "type": "object" } }, "columns": { "type": "array", "items": { "ref": "#/components/schemas/SqlColumn", "type": "object", "required": [ "name", "dataType", "isNullable", "tableName" ], "properties": { "name": { "type": "string", "truncated": true }, "dataType": { "type": "string", "truncated": true }, "isNullable": { "type": "boolean", "truncated": true }, "tableName": { "type": "string", "truncated": true }, "nativeType": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true } } } }, "rowCount": { "type": "number" }, "sqlText": { "type": "string" }, "unit": { "type": "string" }, "autoAnalytics": { "description": "Auto analytics insights" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/analytics/automated-insights" } }, { "id": "query.analytics.rows", "method": "POST", "pathTemplate": "analytics/rows", "stability": "stable", "summary": "Run analytics SQL and return rows", "target": "query", "openapi": { "matched": true, "openapiOperationId": "AnalyticsController.listNewRows", "description": "Will Execute Analytics Queries\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SqlQuery", "type": "object", "properties": { "sqlQuery": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "limit": { "type": "number" }, "tableColumns": { "type": "array", "items": { "type": "object" } }, "aggregateLevel": { "type": "string", "nullable": true, "enum": [ "minute", "hour", "date", "day", "week", "month", "year" ] }, "aggregateType": { "type": "string", "enum": [ "avg", "sum", "count", "min", "max", "median", "std_dev" ] }, "orderByColumn": { "type": "string" }, "orderByDescending": { "type": "boolean" }, "groupByDevice": { "type": "boolean" }, "timeDimension": { "type": "boolean" }, "type": { "type": "string" }, "fillGaps": { "type": "boolean" }, "unit": { "type": "string" }, "timezone": { "type": "string" }, "accountId": { "type": "string" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "SqlQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SqlResult", "type": "object", "required": [ "rows", "columns", "rowCount", "sqlText" ], "properties": { "rows": { "type": "array", "items": { "type": "object" } }, "columns": { "type": "array", "items": { "ref": "#/components/schemas/SqlColumn", "type": "object", "required": [ "name", "dataType", "isNullable", "tableName" ], "properties": { "name": { "type": "string", "truncated": true }, "dataType": { "type": "string", "truncated": true }, "isNullable": { "type": "boolean", "truncated": true }, "tableName": { "type": "string", "truncated": true }, "nativeType": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true } } } }, "rowCount": { "type": "number" }, "sqlText": { "type": "string" }, "unit": { "type": "string" }, "autoAnalytics": { "description": "Auto analytics insights" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/analytics/rows" } }, { "id": "query.analytics.streams.filter", "method": "POST", "pathTemplate": "analytics/streams/filter", "stability": "stable", "summary": "Filter analytics streams", "target": "query", "openapi": { "matched": true, "openapiOperationId": "AnalyticsController.listDeviceStreams", "description": "Retrieves all distinct streams filtered by device\nResource: analytics\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/QueryByDeviceRequest", "type": "object", "required": [ "deviceIds" ], "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "QueryByDeviceRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StreamColumnListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/analytics/streams/filter" } }, { "id": "query.analytics.tables.list", "method": "GET", "pathTemplate": "analytics/tables", "stability": "stable", "summary": "List analytics SQL tables", "target": "query", "openapi": { "matched": true, "openapiOperationId": "AnalyticsController.listTablesWithColumns", "description": "Retrieves all tables with columns and data types\nResource: organization\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SqlTablesListReponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/SqlTable", "type": "object", "required": [ "name", "columns" ], "properties": { "name": { "type": "string", "truncated": true }, "description": { "type": "string", "truncated": true }, "columns": { "type": "array", "items": { "ref": "#/components/schemas/SqlColumn", "type": "object", "required": [ "name", "dataType", "isNullable", "tableName" ], "truncated": true }, "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/analytics/tables" } }, { "id": "query.analytics.task-reports.filter", "method": "POST", "pathTemplate": "analytics/task-reports/filter", "stability": "stable", "summary": "Filter analytics task reports", "target": "query", "openapi": { "matched": true, "openapiOperationId": "AnalyticsController.listTaskReports", "description": "lists all task reports\nResource: analytics\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/QueryByDeviceRequest", "type": "object", "required": [ "deviceIds" ], "properties": { "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "QueryByDeviceRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskReportColumnListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/analytics/task-reports/filter" } }, { "id": "query.metadata.current-value.get", "method": "GET", "pathTemplate": "metadata/{metadataId}/current-value", "stability": "stable", "summary": "Get current value for metadata id", "target": "query", "openapi": { "matched": true, "openapiOperationId": "MetadataController.lastestValueForMetadataId", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [ { "deprecated": false, "description": null, "location": "query", "name": "rangeDays", "required": false, "schema": { "type": "integer", "format": "int64" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/MetadataWithCurrentValue", "type": "object", "required": [ "organizationId", "deviceId", "name", "type" ], "properties": { "currentValueTime": { "type": "string", "format": "date-time" }, "currentValue": { "type": "object" }, "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid" }, "deviceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] }, "flushedToClickhouse": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/metadata/{id}/current-value" } }, { "id": "query.metadata.current-value.list", "method": "POST", "pathTemplate": "metadata/current-value", "stability": "stable", "summary": "List metadata current values", "target": "query", "openapi": { "matched": true, "openapiOperationId": "MetadataController.listMetadataWithCurrentValue", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "ScopeFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/MetadataWithCurrentValueListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/MetadataWithCurrentValue", "type": "object", "required": [ "organizationId", "deviceId", "name", "type" ], "properties": { "currentValueTime": { "type": "string", "format": "date-time", "truncated": true }, "currentValue": { "type": "object", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "tags": { "type": "object", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "flushedToClickhouse": { "type": "boolean", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/metadata/current-value" } }, { "id": "query.metadata.device-ids.list", "method": "POST", "pathTemplate": "metadata/device-ids", "stability": "stable", "summary": "List metadata device ids", "target": "query", "openapi": { "matched": true, "openapiOperationId": "MetadataController.listDeviceIds", "description": "Resource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "ScopeFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UuidListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/metadata/device-ids" } }, { "id": "query.metadata.find-or-create", "method": "POST", "pathTemplate": "metadata/find-or-create", "stability": "stable", "summary": "Find or create metadata", "target": "query", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "query.metadata.query", "method": "POST", "pathTemplate": "metadata/query", "stability": "stable", "summary": "Query metadata", "target": "query", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "query.metadata.search", "method": "POST", "pathTemplate": "metadata", "stability": "stable", "summary": "Search stream metadata", "target": "query", "openapi": { "matched": true, "openapiOperationId": "MetadataController.listMetadata", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/MetadataListQuery", "type": "object", "properties": { "latestPerDeviceStream": { "type": "boolean" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "MetadataListQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/MetadataListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Metadata", "type": "object", "required": [ "organizationId", "deviceId", "name", "type" ], "properties": { "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "tags": { "type": "object", "truncated": true }, "flushedToClickhouse": { "type": "boolean", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "id": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/metadata" } }, { "id": "query.metadata.stream-names.list", "method": "POST", "pathTemplate": "metadata/stream-names", "stability": "stable", "summary": "List metadata stream names", "target": "query", "openapi": { "matched": true, "openapiOperationId": "MetadataController.listStreamNames", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ScopeFilter", "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "ScopeFilter", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StringListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/metadata/stream-names" } }, { "id": "query.online-devices.last-seen.get", "method": "GET", "pathTemplate": "online-devices/{deviceId}/last-seen", "stability": "stable", "summary": "Get last seen timestamp for an online device", "target": "query", "openapi": { "matched": true, "openapiOperationId": "OnlineDevicesController.lastSeen", "description": "Resource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/LastSeenResponse", "type": "object", "required": [ "organizationId", "deviceId", "time" ], "properties": { "organizationId": { "type": "string", "format": "uuid" }, "deviceId": { "type": "string", "format": "uuid" }, "time": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/online-devices/{id}/last-seen" } }, { "id": "query.online-devices.list", "method": "GET", "pathTemplate": "online-devices", "stability": "stable", "summary": "List online device ids", "target": "query", "openapi": { "matched": true, "openapiOperationId": "OnlineDevicesController.online", "description": "Resource: devices\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/UuidListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/online-devices" } }, { "id": "query.presence.counts", "method": "POST", "pathTemplate": "presence/counts", "stability": "stable", "summary": "Query stream presence counts", "target": "query", "openapi": { "matched": true, "openapiOperationId": "PresenceController.countV2", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/IntervalQuery", "type": "object", "required": [ "interval", "start", "end" ], "properties": { "interval": { "type": "string", "enum": [ "minute", "hour", "day" ] }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "aggregate": { "type": "string", "enum": [ "year", "month", "week", "day", "12 hours", "4 hours", "hour", "30 minutes", "5 minutes", "minute", "30 seconds", "5 seconds", "second" ] }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "latestOnly": { "type": "boolean" }, "next": { "type": "object" }, "limit": { "type": "integer", "format": "int64" }, "dropExperimentalQueryData": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "IntervalQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/IsoDateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "date-time" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/presence/counts" } }, { "id": "query.presence.query", "method": "POST", "pathTemplate": "presence", "stability": "stable", "summary": "Query stream presence", "target": "query", "openapi": { "matched": true, "openapiOperationId": "PresenceController.count", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/IntervalQuery", "type": "object", "required": [ "interval", "start", "end" ], "properties": { "interval": { "type": "string", "enum": [ "minute", "hour", "day" ] }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "aggregate": { "type": "string", "enum": [ "year", "month", "week", "day", "12 hours", "4 hours", "hour", "30 minutes", "5 minutes", "minute", "30 seconds", "5 seconds", "second" ] }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "latestOnly": { "type": "boolean" }, "next": { "type": "object" }, "limit": { "type": "integer", "format": "int64" }, "dropExperimentalQueryData": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "IntervalQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/IsoDateListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "string", "format": "date-time" } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/presence" } }, { "id": "query.seek.query", "method": "POST", "pathTemplate": "seek", "stability": "stable", "summary": "Seek around a timestamp", "target": "query", "openapi": { "matched": true, "openapiOperationId": "SeekController.seek", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SeekQuery", "type": "object", "required": [ "direction", "from" ], "properties": { "direction": { "type": "string", "enum": [ "next", "previous" ] }, "from": { "type": "string", "format": "date-time" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "SeekQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SeekResult", "type": "object", "properties": { "time": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/seek" } }, { "id": "query.stream-current-value.device-streams.query", "method": "POST", "pathTemplate": "stream-current-value/device-streams", "stability": "stable", "summary": "Query current values grouped by device streams", "target": "query", "openapi": { "matched": true, "openapiOperationId": "StreamCurrentValueController.deviceStreams", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceStreamQuery", "type": "object", "required": [ "streamNames" ], "properties": { "streamNames": { "type": "array", "items": { "type": "string" } }, "online": { "type": "boolean" }, "sortColumn": { "type": "string" }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "format": "int64" }, "offset": { "type": "integer", "format": "int64" } } } } }, "contentTypes": [ "application/json" ], "description": "DeviceStreamQuery", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeviceStreamListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/DeviceStream", "type": "object", "required": [ "id", "organizationId", "name", "tags", "lastSeen", "online", "streams" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "tags": { "type": "object", "truncated": true }, "lastSeen": { "type": "string", "format": "date-time", "truncated": true }, "online": { "type": "boolean", "truncated": true }, "streams": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/stream-current-value/device-streams" } }, { "id": "query.stream-current-value.query", "method": "POST", "pathTemplate": "stream-current-value", "stability": "stable", "summary": "Query stream current values", "target": "query", "openapi": { "matched": true, "openapiOperationId": "StreamCurrentValueController.query", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StreamCurrentValueQuery", "type": "object", "properties": { "latestOnly": { "type": "boolean" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "StreamCurrentValueQuery", "required": false }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StreamCurrentValueListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/StreamCurrentValue", "type": "object", "required": [ "currentValueTime" ], "properties": { "currentValueTime": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/stream-current-value" } }, { "id": "query.stream-data.export-sheet.create", "method": "POST", "pathTemplate": "queries/export-sheet", "stability": "stable", "summary": "Export stream query results to a sheet", "target": "query", "openapi": { "matched": true, "openapiOperationId": "QueryController.exportSheet", "description": "Resource: integrations\nAuthorized roles: operator", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TelemetryExportSheetRequest", "type": "object", "required": [ "query" ], "properties": { "query": { "ref": "#/components/schemas/Query", "type": "object", "required": [ "start", "end" ], "properties": { "aggregate": { "type": "string", "enum": [ "year", "month", "week", "day", "12 hours", "4 hours", "hour", "30 minutes", "5 minutes", "minute", "30 seconds", "5 seconds", "second" ] }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "latestOnly": { "type": "boolean" }, "next": { "type": "object" }, "limit": { "type": "integer", "format": "int64" }, "dropExperimentalQueryData": { "type": "boolean" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "truncated": true } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "contentTypes": [ "application/json" ], "description": "TelemetryExportSheetRequest", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TelemetryExportSheetResult", "type": "object", "required": [ "spreadsheetUrl", "telemetryNotFound" ], "properties": { "spreadsheetUrl": { "type": "string", "format": "url" }, "telemetryNotFound": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/queries/export-sheet" } }, { "id": "query.stream-data.query", "method": "POST", "pathTemplate": "queries", "stability": "stable", "summary": "Query stream datapoints", "target": "query", "openapi": { "matched": true, "openapiOperationId": "QueryController.query", "description": "Resource: streams\nAuthorized roles: viewer", "parameters": { "cookie": [], "header": [ { "deprecated": false, "description": null, "location": "header", "name": "app-id", "required": false, "schema": { "type": "string" } } ], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Query", "type": "object", "required": [ "start", "end" ], "properties": { "aggregate": { "type": "string", "enum": [ "year", "month", "week", "day", "12 hours", "4 hours", "hour", "30 minutes", "5 minutes", "minute", "30 seconds", "5 seconds", "second" ] }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "latestOnly": { "type": "boolean" }, "next": { "type": "object" }, "limit": { "type": "integer", "format": "int64" }, "dropExperimentalQueryData": { "type": "boolean" }, "tags": { "description": "One or more TagSets (combined with OR logic)", "title": "MultiTagSets", "oneOf": [ { "type": "array", "items": { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true } } }, { "ref": "#/components/schemas/TagSets", "type": "object", "description": "A map of tag keys to an array of values", "title": "TagSets", "additionalProperties": { "type": "array", "items": { "type": "string", "truncated": true } } } ] }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "names": { "type": "array", "items": { "type": "string" } }, "types": { "type": "array", "items": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ] } }, "notTags": { "type": "object" }, "notNames": { "type": "array", "items": { "type": "string" } }, "agentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": "Query", "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/StreamDataListResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/StreamData", "type": "object", "required": [ "name", "deviceId", "tags", "type", "points" ], "properties": { "name": { "type": "string", "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "truncated": true }, "tags": { "type": "object", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "points": { "type": "array", "items": { "type": "object", "truncated": true }, "truncated": true } } } }, "aggregates": { "type": "array", "items": { "ref": "#/components/schemas/StreamAggregateData", "type": "object", "required": [ "name", "deviceId", "tags", "type", "aggregates" ], "properties": { "name": { "type": "string", "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "truncated": true }, "tags": { "type": "object", "truncated": true }, "type": { "type": "string", "enum": [ "bitset", "localization", "point cloud", "location", "file", "health", "transform tree", "battery", "video", "numeric set", "json", "image", "numeric", "text" ], "truncated": true }, "aggregates": { "type": "object", "truncated": true } } } }, "next": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": "", "statusCode": "200" } ], "sourceFile": "contracts/openapi/query.json", "sourcePath": "/queries" } }, { "id": "theopolis.ai-models.create", "method": "POST", "pathTemplate": "ai-models", "stability": "stable", "summary": "Create AI model", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.ai-models.delete", "method": "DELETE", "pathTemplate": "ai-models/{name}", "stability": "stable", "summary": "Delete AI model", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.ai-models.get", "method": "GET", "pathTemplate": "ai-models/{name}", "stability": "stable", "summary": "Get AI model", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.ai-models.list", "method": "GET", "pathTemplate": "ai-models", "stability": "stable", "summary": "List AI models", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.ai-models.patch", "method": "PATCH", "pathTemplate": "ai-models/{name}", "stability": "stable", "summary": "Patch AI model", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.ai-policies.create", "method": "POST", "pathTemplate": "ai-policies", "stability": "stable", "summary": "Create an AI policy", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new AI policy variant from an existing policy. Must include parentPolicyId.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AiPolicyCreate", "type": "object", "required": [ "name", "parentPolicyId", "declarationIds", "autonomySliderIds" ], "properties": { "name": { "type": "string", "description": "Required. Name of the AI policy" }, "parentPolicyId": { "type": "string", "format": "uuid", "description": "Required. ID of parent policy to create variant from" }, "declarationIds": { "type": "array", "description": "IDs of declarations to copy to new policy", "items": { "type": "string", "format": "uuid" } }, "autonomySliderIds": { "type": "array", "description": "IDs of autonomy sliders to copy to new policy", "items": { "type": "string", "format": "uuid" } }, "weight": { "type": "integer", "description": "Weight for A/B testing. If not provided, inherits parent's weight" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AiPolicy", "type": "object", "required": [ "id", "name", "weight", "isEnabled", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the AI policy" }, "parentPolicyId": { "type": "string", "format": "uuid", "nullable": true }, "weight": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "AI policy created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - parentPolicyId is required", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ai-policies" } }, { "id": "theopolis.ai-policies.delete", "method": "DELETE", "pathTemplate": "ai-policies/{policyId}", "stability": "stable", "summary": "Delete an AI policy", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete an AI policy variant. Cannot delete the default policy.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "AI Policy ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "AI policy deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Cannot delete default policy", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": {}, "contentTypes": [], "description": "AI policy not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ai-policies/{id}" } }, { "id": "theopolis.ai-policies.get", "method": "GET", "pathTemplate": "ai-policies/{policyId}", "stability": "stable", "summary": "Get an AI policy", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific AI policy with its declarations and autonomy sliders", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "AI Policy ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AiPolicy", "type": "object", "required": [ "id", "name", "weight", "isEnabled", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the AI policy" }, "parentPolicyId": { "type": "string", "format": "uuid", "nullable": true }, "weight": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "AI policy details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": {}, "contentTypes": [], "description": "AI policy not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ai-policies/{id}" } }, { "id": "theopolis.ai-policies.list", "method": "GET", "pathTemplate": "ai-policies", "stability": "stable", "summary": "List AI policies", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all enabled AI policies. Auto-creates a default policy if none exist.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/AiPolicy", "type": "object", "required": [ "id", "name", "weight", "isEnabled", "organizationId", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of AI policies", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ai-policies" } }, { "id": "theopolis.ai-policies.update", "method": "PATCH", "pathTemplate": "ai-policies/{policyId}", "stability": "stable", "summary": "Update an AI policy", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update the weight of an AI policy variant. Cannot modify the default policy.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "AI Policy ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AiPolicyUpdate", "type": "object", "properties": { "weight": { "type": "integer" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AiPolicy", "type": "object", "required": [ "id", "name", "weight", "isEnabled", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the AI policy" }, "parentPolicyId": { "type": "string", "format": "uuid", "nullable": true }, "weight": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "AI policy updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Cannot modify default policy", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": {}, "contentTypes": [], "description": "AI policy not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ai-policies/{id}" } }, { "id": "theopolis.autonomy.create", "method": "POST", "pathTemplate": "autonomy", "stability": "stable", "summary": "Create an autonomy slider", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new autonomy slider for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AutonomySliderCreate", "type": "object", "required": [ "name", "description", "level" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string", "enum": [ "none", "low", "medium", "high", "total", "custom" ] }, "customAutonomyPrompt": { "type": "string", "nullable": true }, "taskFlowIds": { "type": "array", "description": "Array of TaskFlow IDs - empty array means global (applies to all taskflows)", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AutonomySlider", "type": "object", "required": [ "id", "name", "description", "level", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string", "enum": [ "none", "low", "medium", "high", "total", "custom" ] }, "customAutonomyPrompt": { "type": "string", "nullable": true }, "taskFlowIds": { "type": "array", "description": "Array of TaskFlow IDs - empty array means global (applies to all taskflows)", "items": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Autonomy slider created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/autonomy" } }, { "id": "theopolis.autonomy.delete", "method": "DELETE", "pathTemplate": "autonomy/{autonomyId}", "stability": "stable", "summary": "Delete an autonomy slider", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete an autonomy slider", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The autonomy slider ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Autonomy slider deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Autonomy slider not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/autonomy/{id}" } }, { "id": "theopolis.autonomy.get", "method": "GET", "pathTemplate": "autonomy/{autonomyId}", "stability": "stable", "summary": "Get an autonomy slider", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific autonomy slider by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The autonomy slider ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AutonomySlider", "type": "object", "required": [ "id", "name", "description", "level", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string", "enum": [ "none", "low", "medium", "high", "total", "custom" ] }, "customAutonomyPrompt": { "type": "string", "nullable": true }, "taskFlowIds": { "type": "array", "description": "Array of TaskFlow IDs - empty array means global (applies to all taskflows)", "items": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Autonomy slider found", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Autonomy slider not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/autonomy/{id}" } }, { "id": "theopolis.autonomy.list", "method": "GET", "pathTemplate": "autonomy", "stability": "stable", "summary": "List autonomy sliders", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all autonomy sliders for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/AutonomySlider", "type": "object", "required": [ "id", "name", "description", "level", "organizationId", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of autonomy sliders", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/autonomy" } }, { "id": "theopolis.autonomy.suggestions.generate", "method": "POST", "pathTemplate": "autonomy/suggestions", "stability": "stable", "summary": "Generate autonomy suggestions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Analyzes all feedback comments and human approval patterns using Claude AI to suggest autonomy slider additions, modifications, and removals with reasoning and confidence scores", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Empty request body (reserved for future filters)", "properties": {} } } }, "contentTypes": [ "application/json" ], "description": null, "required": false }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "suggestions" ], "properties": { "suggestions": { "type": "array", "items": { "ref": "#/components/schemas/AutonomySuggestion", "type": "object", "required": [ "action", "name", "description", "level", "reasoning", "approvalExamples", "feedbackStats", "confidenceMetrics" ], "properties": { "action": { "type": "string", "description": "The suggested action: add a new autonomy slider, modify an existing one, or remove an outdated one", "enum": [ "add", "modify", "remove" ], "truncated": true }, "name": { "type": "string", "description": "The name of the autonomy slider", "truncated": true }, "description": { "type": "string", "description": "Description of what this autonomy slider controls", "truncated": true }, "level": { "type": "string", "description": "Suggested autonomy level based on observed patterns", "enum": [ "none", "low", "medium", "high", "total" ], "truncated": true }, "customAutonomyPrompt": { "type": "string", "description": "Optional custom prompt if level is 'custom'", "truncated": true }, "reasoning": { "type": "string", "description": "Detailed explanation of why this suggestion is being made, including specific feedback patterns or themes that support it", "truncated": true }, "approvalExamples": { "type": "array", "description": "Specific examples of human modifications that support this suggestion", "items": { "ref": "#/components/schemas/ApprovalExample", "type": "object", "required": [ "proposedMessage", "approvedMessage", "date" ], "truncated": true }, "truncated": true }, "feedbackStats": { "ref": "#/components/schemas/FeedbackStats", "type": "object", "description": "Statistical breakdown of feedback supporting this suggestion", "required": [ "totalCount", "positiveCount", "negativeCount", "relevantComments" ], "truncated": true }, "confidenceMetrics": { "ref": "#/components/schemas/ConfidenceMetrics", "type": "object", "description": "Detailed confidence metrics showing data quality and strength", "required": [ "sampleSize", "consistencyScore", "recencyScore", "overallConfidence" ], "truncated": true }, "targetAutonomySliderId": { "type": "string", "format": "uuid", "description": "For modify/remove actions: the ID of the autonomy slider to modify or remove. Not applicable for add actions.", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "AI-generated autonomy slider suggestions", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "AI service error", "statusCode": "500" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/autonomy/suggestions" } }, { "id": "theopolis.autonomy.update", "method": "PATCH", "pathTemplate": "autonomy/{autonomyId}", "stability": "stable", "summary": "Update an autonomy slider", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing autonomy slider", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The autonomy slider ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AutonomySliderUpdate", "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string", "enum": [ "none", "low", "medium", "high", "total", "custom" ] }, "customAutonomyPrompt": { "type": "string", "nullable": true }, "taskFlowIds": { "type": "array", "description": "Array of TaskFlow IDs - empty array means global (applies to all taskflows)", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/AutonomySlider", "type": "object", "required": [ "id", "name", "description", "level", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string", "enum": [ "none", "low", "medium", "high", "total", "custom" ] }, "customAutonomyPrompt": { "type": "string", "nullable": true }, "taskFlowIds": { "type": "array", "description": "Array of TaskFlow IDs - empty array means global (applies to all taskflows)", "items": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Autonomy slider updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Autonomy slider not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/autonomy/{id}" } }, { "id": "theopolis.board-columns.create", "method": "POST", "pathTemplate": "boards/columns", "stability": "stable", "summary": "Create a board column", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new work column for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/BoardColumnCreate", "type": "object", "required": [ "name", "position" ], "properties": { "name": { "type": "string" }, "position": { "type": "integer" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/BoardColumn", "type": "object", "required": [ "id", "organizationId", "name", "position", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer" }, "isEnabled": { "type": "boolean", "description": "Whether the column is enabled or disabled. Columns cannot be deleted, only disabled." }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Board column created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/boards/columns" } }, { "id": "theopolis.board-columns.delete", "method": "DELETE", "pathTemplate": "boards/columns/{columnId}", "stability": "stable", "summary": "Delete a board column", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete a work column by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the work column", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Board column deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Board column not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/boards/columns/{id}" } }, { "id": "theopolis.board-columns.get", "method": "GET", "pathTemplate": "boards/columns/{columnId}", "stability": "stable", "summary": "Get a board column", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific work column by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the work column", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/BoardColumn", "type": "object", "required": [ "id", "organizationId", "name", "position", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer" }, "isEnabled": { "type": "boolean", "description": "Whether the column is enabled or disabled. Columns cannot be deleted, only disabled." }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Board column details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Board column not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/boards/columns/{id}" } }, { "id": "theopolis.board-columns.list", "method": "GET", "pathTemplate": "boards/columns", "stability": "stable", "summary": "List board columns", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all work columns for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/BoardColumn", "type": "object", "required": [ "id", "organizationId", "name", "position", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of work columns", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/boards/columns" } }, { "id": "theopolis.board-columns.update", "method": "PUT", "pathTemplate": "boards/columns/{columnId}", "stability": "stable", "summary": "Update a board column", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.channel-monitors.create", "method": "POST", "pathTemplate": "channel-monitors", "stability": "stable", "summary": "Create a channel monitor", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new channel monitor to trigger a taskflow when messages arrive in a Slack/Teams channel", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "platform", "channelId", "channelName", "taskFlowId" ], "properties": { "platform": { "type": "string", "enum": [ "slack", "teams" ] }, "channelId": { "type": "string", "description": "The Slack/Teams channel ID" }, "channelName": { "type": "string", "description": "Human-readable channel name" }, "taskFlowId": { "type": "string", "format": "uuid", "description": "The taskflow to trigger when messages arrive" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ChannelMonitor", "type": "object", "required": [ "id", "organizationId", "platform", "channelId", "channelName", "taskFlowId", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "platform": { "type": "string", "description": "The messaging platform", "enum": [ "slack", "teams" ] }, "channelId": { "type": "string", "description": "The Slack/Teams channel ID" }, "channelName": { "type": "string", "description": "Human-readable channel name" }, "taskFlowId": { "type": "string", "format": "uuid", "description": "The taskflow to trigger when messages arrive" }, "isEnabled": { "type": "boolean", "description": "Whether the monitor is active" }, "botFilterMode": { "type": "string", "description": "Bot filtering mode: 'all' to allow all bots, 'regex' to filter by pattern", "enum": [ "all", "regex" ] }, "botFilterPattern": { "type": "string", "description": "Regex pattern to filter bot messages (only used when botFilterMode is 'regex')", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Channel monitor created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Monitor already exists for this channel", "statusCode": "400" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/channel-monitors" } }, { "id": "theopolis.channel-monitors.delete", "method": "DELETE", "pathTemplate": "channel-monitors/{channelMonitorId}", "stability": "stable", "summary": "Delete a channel monitor", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete a channel monitor", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Channel monitor deleted successfully", "statusCode": "204" }, { "content": {}, "contentTypes": [], "description": "Channel monitor not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/channel-monitors/{id}" } }, { "id": "theopolis.channel-monitors.get", "method": "GET", "pathTemplate": "channel-monitors/{channelMonitorId}", "stability": "stable", "summary": "Get a channel monitor", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific channel monitor", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ChannelMonitor", "type": "object", "required": [ "id", "organizationId", "platform", "channelId", "channelName", "taskFlowId", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "platform": { "type": "string", "description": "The messaging platform", "enum": [ "slack", "teams" ] }, "channelId": { "type": "string", "description": "The Slack/Teams channel ID" }, "channelName": { "type": "string", "description": "Human-readable channel name" }, "taskFlowId": { "type": "string", "format": "uuid", "description": "The taskflow to trigger when messages arrive" }, "isEnabled": { "type": "boolean", "description": "Whether the monitor is active" }, "botFilterMode": { "type": "string", "description": "Bot filtering mode: 'all' to allow all bots, 'regex' to filter by pattern", "enum": [ "all", "regex" ] }, "botFilterPattern": { "type": "string", "description": "Regex pattern to filter bot messages (only used when botFilterMode is 'regex')", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Channel monitor details", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Channel monitor not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/channel-monitors/{id}" } }, { "id": "theopolis.channel-monitors.list", "method": "GET", "pathTemplate": "channel-monitors", "stability": "stable", "summary": "List channel monitors", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all channel monitors for the organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Filter by platform (optional)", "location": "query", "name": "platform", "required": false, "schema": { "type": "string", "enum": [ "slack", "teams" ] } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/ChannelMonitor", "type": "object", "required": [ "id", "organizationId", "platform", "channelId", "channelName", "taskFlowId", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "platform": { "type": "string", "description": "The messaging platform", "enum": [ "slack", "teams" ], "truncated": true }, "channelId": { "type": "string", "description": "The Slack/Teams channel ID", "truncated": true }, "channelName": { "type": "string", "description": "Human-readable channel name", "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "description": "The taskflow to trigger when messages arrive", "truncated": true }, "isEnabled": { "type": "boolean", "description": "Whether the monitor is active", "truncated": true }, "botFilterMode": { "type": "string", "description": "Bot filtering mode: 'all' to allow all bots, 'regex' to filter by pattern", "enum": [ "all", "regex" ], "truncated": true }, "botFilterPattern": { "type": "string", "description": "Regex pattern to filter bot messages (only used when botFilterMode is 'regex')", "nullable": true, "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "updatedBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of channel monitors", "statusCode": "200" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/channel-monitors" } }, { "id": "theopolis.channel-monitors.update", "method": "PATCH", "pathTemplate": "channel-monitors/{channelMonitorId}", "stability": "stable", "summary": "Update a channel monitor", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing channel monitor", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskFlowId": { "type": "string", "format": "uuid" }, "channelName": { "type": "string" }, "isEnabled": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ChannelMonitor", "type": "object", "required": [ "id", "organizationId", "platform", "channelId", "channelName", "taskFlowId", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "platform": { "type": "string", "description": "The messaging platform", "enum": [ "slack", "teams" ] }, "channelId": { "type": "string", "description": "The Slack/Teams channel ID" }, "channelName": { "type": "string", "description": "Human-readable channel name" }, "taskFlowId": { "type": "string", "format": "uuid", "description": "The taskflow to trigger when messages arrive" }, "isEnabled": { "type": "boolean", "description": "Whether the monitor is active" }, "botFilterMode": { "type": "string", "description": "Bot filtering mode: 'all' to allow all bots, 'regex' to filter by pattern", "enum": [ "all", "regex" ] }, "botFilterPattern": { "type": "string", "description": "Regex pattern to filter bot messages (only used when botFilterMode is 'regex')", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Channel monitor updated successfully", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Channel monitor not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/channel-monitors/{id}" } }, { "id": "theopolis.declarations.create", "method": "POST", "pathTemplate": "declarations", "stability": "stable", "summary": "Create a declaration", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new declaration (mandate or guardrail) for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeclarationCreate", "type": "object", "required": [ "type", "message" ], "properties": { "type": { "type": "string", "enum": [ "mandate", "guardrail" ] }, "message": { "type": "string" }, "sourceType": { "type": "string", "description": "Origin of the declaration (optional, defaults to 'manual')", "enum": [ "manual", "suggestion", "imported" ] }, "suggestionReasoning": { "type": "string", "description": "AI reasoning if created from a suggestion (optional)" }, "suggestionMetadata": { "type": "object", "description": "Metadata from suggestion including approval examples, feedback stats, and confidence metrics (optional)" }, "basedOnSuggestionId": { "type": "string", "format": "uuid", "description": "Links to the original suggestion if applicable (optional)" }, "taskflowIds": { "type": "array", "description": "Array of taskflow IDs this declaration applies to (optional). Empty array means applies to all taskflows.", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Declaration", "type": "object", "required": [ "id", "type", "message", "organizationId", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "mandate", "guardrail" ] }, "message": { "type": "string" }, "isEnabled": { "type": "boolean" }, "sourceType": { "type": "string", "description": "Origin of the declaration", "enum": [ "manual", "suggestion", "imported" ] }, "suggestionReasoning": { "type": "string", "description": "AI reasoning if created from a suggestion", "nullable": true }, "suggestionMetadata": { "type": "object", "description": "Metadata from suggestion including approval examples, feedback stats, and confidence metrics", "nullable": true }, "basedOnSuggestionId": { "type": "string", "format": "uuid", "description": "Links to the original suggestion if applicable", "nullable": true }, "taskflowIds": { "type": "array", "description": "Array of taskflow IDs this declaration applies to. Empty array means applies to all taskflows.", "items": { "type": "string", "format": "uuid" } }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Declaration created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/declarations" } }, { "id": "theopolis.declarations.delete", "method": "DELETE", "pathTemplate": "declarations/{declarationId}", "stability": "stable", "summary": "Delete a declaration", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete a declaration (sets isEnabled to false)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The declaration ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Declaration deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Declaration not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/declarations/{id}" } }, { "id": "theopolis.declarations.get", "method": "GET", "pathTemplate": "declarations/{declarationId}", "stability": "stable", "summary": "Get a declaration", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific declaration by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The declaration ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Declaration", "type": "object", "required": [ "id", "type", "message", "organizationId", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "mandate", "guardrail" ] }, "message": { "type": "string" }, "isEnabled": { "type": "boolean" }, "sourceType": { "type": "string", "description": "Origin of the declaration", "enum": [ "manual", "suggestion", "imported" ] }, "suggestionReasoning": { "type": "string", "description": "AI reasoning if created from a suggestion", "nullable": true }, "suggestionMetadata": { "type": "object", "description": "Metadata from suggestion including approval examples, feedback stats, and confidence metrics", "nullable": true }, "basedOnSuggestionId": { "type": "string", "format": "uuid", "description": "Links to the original suggestion if applicable", "nullable": true }, "taskflowIds": { "type": "array", "description": "Array of taskflow IDs this declaration applies to. Empty array means applies to all taskflows.", "items": { "type": "string", "format": "uuid" } }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Declaration found", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Declaration not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/declarations/{id}" } }, { "id": "theopolis.declarations.list", "method": "GET", "pathTemplate": "declarations", "stability": "stable", "summary": "List declarations", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all declarations (mandates and guardrails) for the authenticated user's organization, optionally filtered by type", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Filter by type (mandate or guardrail)", "location": "query", "name": "type", "required": false, "schema": { "type": "string", "enum": [ "mandate", "guardrail" ] } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Declaration", "type": "object", "required": [ "id", "type", "message", "organizationId", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of declarations", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/declarations" } }, { "id": "theopolis.declarations.suggestions.generate", "method": "POST", "pathTemplate": "declarations/suggestions", "stability": "stable", "summary": "Generate declaration suggestions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Analyzes all feedback comments (TaskFeedback, InvestigationFeedback, TaskResultSectionFeedback) using Claude AI to suggest declaration additions, modifications, and removals with reasoning and confidence scores", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Empty request body (reserved for future filters)", "properties": {} } } }, "contentTypes": [ "application/json" ], "description": null, "required": false }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "suggestions" ], "properties": { "suggestions": { "type": "array", "items": { "ref": "#/components/schemas/DeclarationSuggestion", "type": "object", "required": [ "action", "type", "message", "reasoning", "approvalExamples", "feedbackStats", "confidenceMetrics" ], "properties": { "action": { "type": "string", "description": "The suggested action: add a new declaration, modify an existing one, or remove an outdated one", "enum": [ "add", "modify", "remove" ], "truncated": true }, "type": { "type": "string", "description": "Type of declaration: mandate (best practice to follow) or guardrail (mistake to avoid)", "enum": [ "mandate", "guardrail" ], "truncated": true }, "message": { "type": "string", "description": "The declaration message text", "truncated": true }, "reasoning": { "type": "string", "description": "Detailed explanation of why this suggestion is being made, including specific feedback patterns or themes that support it", "truncated": true }, "approvalExamples": { "type": "array", "description": "Specific examples of human modifications that support this suggestion", "items": { "ref": "#/components/schemas/ApprovalExample", "type": "object", "required": [ "proposedMessage", "approvedMessage", "date" ], "truncated": true }, "truncated": true }, "feedbackStats": { "ref": "#/components/schemas/FeedbackStats", "type": "object", "description": "Statistical breakdown of feedback supporting this suggestion", "required": [ "totalCount", "positiveCount", "negativeCount", "relevantComments" ], "truncated": true }, "confidenceMetrics": { "ref": "#/components/schemas/ConfidenceMetrics", "type": "object", "description": "Detailed confidence metrics showing data quality and strength", "required": [ "sampleSize", "consistencyScore", "recencyScore", "overallConfidence" ], "truncated": true }, "targetDeclarationId": { "type": "string", "format": "uuid", "description": "For modify/remove actions: the ID of the declaration to modify or remove. Not applicable for add actions.", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "AI-generated declaration suggestions", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "AI service error", "statusCode": "500" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/declarations/suggestions" } }, { "id": "theopolis.declarations.update", "method": "PATCH", "pathTemplate": "declarations/{declarationId}", "stability": "stable", "summary": "Update a declaration", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing declaration", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The declaration ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/DeclarationUpdate", "type": "object", "properties": { "type": { "type": "string", "enum": [ "mandate", "guardrail" ] }, "message": { "type": "string" }, "sourceType": { "type": "string", "description": "Origin of the declaration (optional)", "enum": [ "manual", "suggestion", "imported" ] }, "suggestionReasoning": { "type": "string", "description": "AI reasoning if created from a suggestion (optional)" }, "suggestionMetadata": { "type": "object", "description": "Metadata from suggestion (optional)" }, "basedOnSuggestionId": { "type": "string", "format": "uuid", "description": "Links to the original suggestion if applicable (optional)" }, "taskflowIds": { "type": "array", "description": "Array of taskflow IDs this declaration applies to (optional). Empty array means applies to all taskflows.", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Declaration", "type": "object", "required": [ "id", "type", "message", "organizationId", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "mandate", "guardrail" ] }, "message": { "type": "string" }, "isEnabled": { "type": "boolean" }, "sourceType": { "type": "string", "description": "Origin of the declaration", "enum": [ "manual", "suggestion", "imported" ] }, "suggestionReasoning": { "type": "string", "description": "AI reasoning if created from a suggestion", "nullable": true }, "suggestionMetadata": { "type": "object", "description": "Metadata from suggestion including approval examples, feedback stats, and confidence metrics", "nullable": true }, "basedOnSuggestionId": { "type": "string", "format": "uuid", "description": "Links to the original suggestion if applicable", "nullable": true }, "taskflowIds": { "type": "array", "description": "Array of taskflow IDs this declaration applies to. Empty array means applies to all taskflows.", "items": { "type": "string", "format": "uuid" } }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Declaration updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Declaration not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/declarations/{id}" } }, { "id": "theopolis.feedback-forms.create", "method": "POST", "pathTemplate": "feedback-forms", "stability": "stable", "summary": "Create feedback form", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new feedback form for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/FeedbackFormCreate", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "questions": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackFormQuestion", "type": "object", "required": [ "id", "questionText", "questionType", "isRequired", "orderIndex" ], "properties": { "id": { "type": "string", "format": "uuid" }, "questionText": { "type": "string" }, "questionType": { "type": "string", "enum": [ "text", "rating", "multipleChoice", "yesNo" ] }, "isRequired": { "type": "boolean" }, "orderIndex": { "type": "integer" }, "options": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "allowMultiple": { "type": "boolean", "truncated": true }, "minRating": { "type": "integer", "truncated": true }, "maxRating": { "type": "integer", "truncated": true } } } } } }, "taskFlowIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isEnabled": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/FeedbackForm", "type": "object", "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "questions": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackFormQuestion", "type": "object", "required": [ "id", "questionText", "questionType", "isRequired", "orderIndex" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "questionText": { "type": "string", "truncated": true }, "questionType": { "type": "string", "enum": [ "text", "rating", "multipleChoice", "yesNo" ], "truncated": true }, "isRequired": { "type": "boolean", "truncated": true }, "orderIndex": { "type": "integer", "truncated": true }, "options": { "type": "object", "truncated": true } } } }, "taskFlowIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Successfully created feedback form", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - Invalid input", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/feedback-forms" } }, { "id": "theopolis.feedback-forms.delete", "method": "DELETE", "pathTemplate": "feedback-forms/{formId}", "stability": "stable", "summary": "Delete feedback form", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete a feedback form by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the feedback form to delete", "location": "path", "name": "formId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Successfully deleted feedback form", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Feedback form not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/feedback-forms/{formId}" } }, { "id": "theopolis.feedback-forms.get", "method": "GET", "pathTemplate": "feedback-forms/{formId}", "stability": "stable", "summary": "Get feedback form", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a feedback form by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the feedback form to retrieve", "location": "path", "name": "formId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/FeedbackForm", "type": "object", "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "questions": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackFormQuestion", "type": "object", "required": [ "id", "questionText", "questionType", "isRequired", "orderIndex" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "questionText": { "type": "string", "truncated": true }, "questionType": { "type": "string", "enum": [ "text", "rating", "multipleChoice", "yesNo" ], "truncated": true }, "isRequired": { "type": "boolean", "truncated": true }, "orderIndex": { "type": "integer", "truncated": true }, "options": { "type": "object", "truncated": true } } } }, "taskFlowIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Feedback form details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Feedback form not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/feedback-forms/{formId}" } }, { "id": "theopolis.feedback-forms.list", "method": "GET", "pathTemplate": "feedback-forms", "stability": "stable", "summary": "List feedback forms", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all feedback forms for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackForm", "type": "object", "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of feedback forms", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/feedback-forms" } }, { "id": "theopolis.feedback-forms.update", "method": "PUT", "pathTemplate": "feedback-forms/{formId}", "stability": "stable", "summary": "Update feedback form", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing feedback form by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the feedback form to update", "location": "path", "name": "formId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/FeedbackFormUpdate", "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "questions": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackFormQuestion", "type": "object", "required": [ "id", "questionText", "questionType", "isRequired", "orderIndex" ], "properties": { "id": { "type": "string", "format": "uuid" }, "questionText": { "type": "string" }, "questionType": { "type": "string", "enum": [ "text", "rating", "multipleChoice", "yesNo" ] }, "isRequired": { "type": "boolean" }, "orderIndex": { "type": "integer" }, "options": { "type": "object", "properties": { "choices": { "type": "array", "items": { "type": "string", "truncated": true }, "truncated": true }, "allowMultiple": { "type": "boolean", "truncated": true }, "minRating": { "type": "integer", "truncated": true }, "maxRating": { "type": "integer", "truncated": true } } } } } }, "taskFlowIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isEnabled": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/FeedbackForm", "type": "object", "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "questions": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackFormQuestion", "type": "object", "required": [ "id", "questionText", "questionType", "isRequired", "orderIndex" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "questionText": { "type": "string", "truncated": true }, "questionType": { "type": "string", "enum": [ "text", "rating", "multipleChoice", "yesNo" ], "truncated": true }, "isRequired": { "type": "boolean", "truncated": true }, "orderIndex": { "type": "integer", "truncated": true }, "options": { "type": "object", "truncated": true } } } }, "taskFlowIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Successfully updated feedback form", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - Invalid input", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Feedback form not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/feedback-forms/{formId}" } }, { "id": "theopolis.fine-tuned-models.create", "method": "POST", "pathTemplate": "fine-tuned-models", "stability": "stable", "summary": "Create a fine-tuned model", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.fine-tuned-models.delete", "method": "DELETE", "pathTemplate": "fine-tuned-models/{name}", "stability": "stable", "summary": "Delete a fine-tuned model", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.fine-tuned-models.list", "method": "GET", "pathTemplate": "fine-tuned-models", "stability": "stable", "summary": "List fine-tuned models", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.fine-tuned-models.names.list", "method": "GET", "pathTemplate": "fine-tuned-models/names", "stability": "stable", "summary": "List fine-tuned model names", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.ground-truths.create", "method": "POST", "pathTemplate": "ground-truths", "stability": "stable", "summary": "Create a ground truth", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new ground truth for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/GroundTruthCreate", "type": "object", "required": [ "reality", "time" ], "properties": { "reality": { "type": "string" }, "time": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/GroundTruth", "type": "object", "required": [ "id", "reality", "time", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "reality": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Ground truth created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ground-truths" } }, { "id": "theopolis.ground-truths.delete", "method": "DELETE", "pathTemplate": "ground-truths/{groundTruthId}", "stability": "stable", "summary": "Delete a ground truth", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete a ground truth", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ground truth ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Ground truth deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Ground truth not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ground-truths/{id}" } }, { "id": "theopolis.ground-truths.get", "method": "GET", "pathTemplate": "ground-truths/{groundTruthId}", "stability": "stable", "summary": "Get a ground truth", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific ground truth by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ground truth ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/GroundTruth", "type": "object", "required": [ "id", "reality", "time", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "reality": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Ground truth found", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Ground truth not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ground-truths/{id}" } }, { "id": "theopolis.ground-truths.list", "method": "GET", "pathTemplate": "ground-truths", "stability": "stable", "summary": "List ground truths", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all ground truths for the authenticated user's organization. Can be filtered by time range using startTime and endTime query parameters.", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Filter ground truths with time <= endTime", "location": "query", "name": "endTime", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "deprecated": false, "description": "Filter ground truths with time >= startTime", "location": "query", "name": "startTime", "required": false, "schema": { "type": "string", "format": "date-time" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/GroundTruth", "type": "object", "required": [ "id", "reality", "time", "organizationId", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of ground truths", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ground-truths" } }, { "id": "theopolis.ground-truths.update", "method": "PATCH", "pathTemplate": "ground-truths/{groundTruthId}", "stability": "stable", "summary": "Update a ground truth", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing ground truth", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ground truth ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/GroundTruthUpdate", "type": "object", "properties": { "reality": { "type": "string" }, "time": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/GroundTruth", "type": "object", "required": [ "id", "reality", "time", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "reality": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Ground truth updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Ground truth not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/ground-truths/{id}" } }, { "id": "theopolis.investigations.analytics", "method": "POST", "pathTemplate": "investigations/analytics", "stability": "stable", "summary": "Get investigation analytics", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve time-series analytics data for investigations. Can filter by TaskFlow end node types (false_alarm, resolved, escalated) or Signal types (manual, eventTrigger, schedule, slack)", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "startTime", "endTime", "interval" ], "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start of the time range (ISO 8601 datetime)" }, "endTime": { "type": "string", "format": "date-time", "description": "End of the time range (ISO 8601 datetime)" }, "type": { "type": "string", "description": "Optional type to filter by. EndNodeResultTypes: 'false_alarm', 'resolved', 'escalated' (filters by TaskFlow end node type). SignalTypes: 'manual', 'eventTrigger', 'schedule', 'slack' (filters by Signal.type). If not provided, returns all investigations. For 'resolved', includes investigations with no endNodeType or endNodeType='resolved'. For 'false_alarm' or 'escalated', exact match only.", "enum": [ "false_alarm", "resolved", "escalated", "manual", "eventTrigger", "schedule", "slack" ] }, "interval": { "type": "string", "description": "Time interval for data aggregation", "enum": [ "daily", "hourly" ] }, "groupBy": { "type": "string", "description": "Optional grouping for analytics data. If provided, returns counts grouped by the specified dimension along with timestamp.", "enum": [ "resultType", "signalType" ] } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "count" ], "properties": { "timestamp": { "type": "string", "description": "Time bucket in format YYYY-MM-DD for daily or YYYY-MM-DD HH24:00:00 for hourly", "truncated": true }, "count": { "type": "integer", "description": "Number of investigations in this time bucket", "truncated": true }, "group": { "type": "string", "description": "The group name if groupBy parameter was used (e.g., 'resolved', 'slack')", "truncated": true } } } }, "metadata": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start time from request" }, "endTime": { "type": "string", "format": "date-time", "description": "End time from request" }, "type": { "type": "string", "description": "Investigation type from request (may be undefined if not filtered)" }, "interval": { "type": "string", "description": "Time interval from request" }, "totalCount": { "type": "integer", "description": "Total count across all time buckets" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Analytics data retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid parameters", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/analytics" } }, { "id": "theopolis.investigations.artifacts.create", "method": "POST", "pathTemplate": "investigations/{investigationId}/artifacts", "stability": "stable", "summary": "Create investigation artifact", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.investigations.artifacts.list", "method": "GET", "pathTemplate": "investigations/{investigationId}/artifacts", "stability": "stable", "summary": "List investigation artifacts", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all URLs found in task runs associated with an investigation's taskflow run", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationArtifactsResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of URLs found in task runs associated with the investigation", "items": { "ref": "#/components/schemas/InvestigationArtifact", "type": "object", "required": [ "url", "source", "taskRunId", "nodeId" ], "properties": { "url": { "type": "string", "format": "uri", "description": "A URL found in task run content", "truncated": true }, "source": { "type": "string", "description": "The source where this URL was found", "enum": [ "task_run" ], "truncated": true }, "taskRunId": { "type": "string", "format": "uuid", "description": "The ID of the task run where this URL was found", "truncated": true }, "nodeId": { "type": "string", "description": "The node ID in the taskflow graph that executed this task run", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of URLs found in task runs with metadata", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found or has no associated task flow run", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}/artifacts" } }, { "id": "theopolis.investigations.create", "method": "POST", "pathTemplate": "investigations", "stability": "stable", "summary": "Create investigation", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new investigation for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationCreate", "type": "object", "required": [ "signalId", "name", "goal" ], "properties": { "signalId": { "type": "string" }, "boardColumnId": { "type": "string", "format": "uuid", "description": "The board column this investigation is in. Can be null for investigations not placed on boards.", "nullable": true }, "name": { "type": "string" }, "parentInvestigationId": { "type": "string", "format": "uuid", "description": "The ID of the parent investigation if this is a sub-investigation" }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the task. Can be null for taskflow investigations.", "nullable": true }, "goal": { "type": "string", "description": "The goal for the task to accomplish" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Investigation", "type": "object", "required": [ "id", "organizationId", "signalId", "name", "isArchived", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "signalId": { "type": "string" }, "boardColumnId": { "type": "string", "format": "uuid", "description": "The board column this investigation is in. Can be null for investigations not placed on boards (e.g., taskflow-generated investigations).", "nullable": true }, "name": { "type": "string" }, "isArchived": { "type": "boolean", "description": "Indicates whether the investigation is archived" }, "isTest": { "type": "boolean", "description": "Indicates if this is a test investigation that should not appear on boards" }, "parentInvestigationId": { "type": "string", "format": "uuid", "description": "The ID of the parent investigation if this is a sub-investigation" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "details": { "type": "object", "description": "Optional detailed information included when details=true query parameter is used", "properties": { "signal": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "threadId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true, "truncated": true }, "goal": { "type": "string", "truncated": true }, "model": { "type": "string", "nullable": true, "truncated": true }, "scheduleCron": { "type": "string", "nullable": true, "truncated": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ], "truncated": true }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "truncated": true }, "result": { "type": "string", "nullable": true, "truncated": true }, "summarySoFar": { "type": "string", "nullable": true, "truncated": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards", "truncated": true }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ], "truncated": true }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true, "truncated": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true, "truncated": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true, "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true, "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } }, "tasks": { "type": "array", "description": "All tasks associated with this investigation", "items": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations" } }, { "id": "theopolis.investigations.delete", "method": "DELETE", "pathTemplate": "investigations/{investigationId}", "stability": "stable", "summary": "Delete investigation", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Archive an existing investigation by setting isArchived to true (soft delete)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Investigation deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}" } }, { "id": "theopolis.investigations.feedback-forms.list", "method": "GET", "pathTemplate": "investigations/{investigationId}/feedback-forms", "stability": "stable", "summary": "List investigation feedback forms", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all feedback forms associated with a specific investigation", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/FeedbackForm", "type": "object", "required": [ "id", "name", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of feedback forms for the investigation", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}/feedback-forms" } }, { "id": "theopolis.investigations.get", "method": "GET", "pathTemplate": "investigations/{investigationId}", "stability": "stable", "summary": "Get investigation", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific investigation by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Investigation", "type": "object", "required": [ "id", "organizationId", "signalId", "name", "isArchived", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "signalId": { "type": "string" }, "boardColumnId": { "type": "string", "format": "uuid", "description": "The board column this investigation is in. Can be null for investigations not placed on boards (e.g., taskflow-generated investigations).", "nullable": true }, "name": { "type": "string" }, "isArchived": { "type": "boolean", "description": "Indicates whether the investigation is archived" }, "isTest": { "type": "boolean", "description": "Indicates if this is a test investigation that should not appear on boards" }, "parentInvestigationId": { "type": "string", "format": "uuid", "description": "The ID of the parent investigation if this is a sub-investigation" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "details": { "type": "object", "description": "Optional detailed information included when details=true query parameter is used", "properties": { "signal": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "threadId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true, "truncated": true }, "goal": { "type": "string", "truncated": true }, "model": { "type": "string", "nullable": true, "truncated": true }, "scheduleCron": { "type": "string", "nullable": true, "truncated": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ], "truncated": true }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "truncated": true }, "result": { "type": "string", "nullable": true, "truncated": true }, "summarySoFar": { "type": "string", "nullable": true, "truncated": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards", "truncated": true }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ], "truncated": true }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true, "truncated": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true, "truncated": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true, "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true, "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } }, "tasks": { "type": "array", "description": "All tasks associated with this investigation", "items": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}" } }, { "id": "theopolis.investigations.perspectives.analytics", "method": "POST", "pathTemplate": "investigations/perspectives/{id}/analytics", "stability": "stable", "summary": "Get perspective analytics", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve analytics data for investigations categorized under a specific perspective, including category breakdowns and optional sparklines for time-series visualization", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the perspective", "location": "path", "name": "perspectiveId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "timeRange" ], "properties": { "timeRange": { "type": "string", "description": "The time range for analytics data", "enum": [ "last_hour", "last_day", "last_week", "last_month", "last_year" ] }, "includeSparklines": { "type": "boolean", "description": "Whether to include sparkline time-series data" }, "sparklineGranularity": { "type": "string", "description": "The granularity for sparkline buckets. If not specified, it will be auto-calculated based on timeRange", "enum": [ "minute", "hour", "day", "week", "month" ] } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PerspectiveAnalytics", "type": "object", "required": [ "perspectiveId", "perspectiveName", "perspectiveDescription", "timeRange", "startTime", "endTime", "totalInvestigations", "categoryBreakdown", "kpiSummary" ], "properties": { "perspectiveId": { "type": "string", "format": "uuid", "description": "The ID of the perspective" }, "perspectiveName": { "type": "string", "description": "The name of the perspective" }, "perspectiveDescription": { "type": "string", "description": "Description of the perspective", "nullable": true }, "timeRange": { "type": "string", "description": "The time range for the analytics", "enum": [ "last_hour", "last_day", "last_week", "last_month", "last_year" ] }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the analytics period" }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the analytics period" }, "totalInvestigations": { "type": "integer", "description": "Total number of investigations in the time range" }, "categoryBreakdown": { "type": "array", "description": "Breakdown of investigations by category", "items": { "ref": "#/components/schemas/CategoryBreakdown", "type": "object", "required": [ "categoryId", "categoryName", "categoryDescription", "investigationCount", "percentage", "measurements" ], "properties": { "categoryId": { "type": "string", "format": "uuid", "truncated": true }, "categoryName": { "type": "string", "truncated": true }, "categoryDescription": { "type": "string", "truncated": true }, "investigationCount": { "type": "integer", "truncated": true }, "percentage": { "type": "number", "description": "Percentage of total investigations", "truncated": true }, "measurements": { "type": "object", "description": "Measurement analytics keyed by measurement ID", "truncated": true }, "sparkline": { "ref": "#/components/schemas/SparklineData", "type": "object", "description": "Time-series data for category investigation counts", "required": [ "timestamps", "values" ], "truncated": true } } } }, "kpiSummary": { "type": "array", "description": "KPI summary aggregated across all categories", "items": { "ref": "#/components/schemas/KpiSummary", "type": "object", "required": [ "measurementId", "measurementName", "measurementDescription", "shouldBeSummed" ], "properties": { "measurementId": { "type": "string", "format": "uuid", "truncated": true }, "measurementName": { "type": "string", "truncated": true }, "measurementDescription": { "type": "string", "truncated": true }, "shouldBeSummed": { "type": "boolean", "truncated": true }, "total": { "type": "number", "description": "Total value across all categories", "truncated": true }, "sparkline": { "ref": "#/components/schemas/SparklineData", "type": "object", "required": [ "timestamps", "values" ], "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Analytics retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - Invalid time range or parameters", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives/{perspectiveId}/analytics" } }, { "id": "theopolis.investigations.perspectives.categorizations", "method": "GET", "pathTemplate": "investigations/perspectives/{id}/categorizations", "stability": "stable", "summary": "Get perspective categorizations", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve paginated list of investigation categorizations for a specific perspective with optional filtering", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the perspective", "location": "path", "name": "perspectiveId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [ { "deprecated": false, "description": "Filter by category ID", "location": "query", "name": "categoryId", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "Filter by investigation completion date (end)", "location": "query", "name": "endDate", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "deprecated": false, "description": "Filter by test status", "location": "query", "name": "isTest", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "deprecated": false, "description": "Number of items per page (max 100)", "location": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "deprecated": false, "description": "Page number for pagination", "location": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "deprecated": false, "description": "Filter by investigation completion date (start)", "location": "query", "name": "startDate", "required": false, "schema": { "type": "string", "format": "date-time" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "investigationId": { "type": "string", "format": "uuid", "truncated": true }, "categoryId": { "type": "string", "format": "uuid", "truncated": true }, "reasoning": { "type": "string", "truncated": true }, "isTest": { "type": "boolean", "truncated": true }, "investigationCompletedAt": { "type": "string", "format": "date-time", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "investigationName": { "type": "string", "truncated": true }, "isArchived": { "type": "boolean", "truncated": true }, "categoryName": { "type": "string", "truncated": true }, "categoryDescription": { "type": "string", "nullable": true, "truncated": true } } } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "totalPages": { "type": "integer" }, "hasMore": { "type": "boolean" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Categorizations retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - Invalid perspective ID or parameters", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives/{perspectiveId}/categorizations" } }, { "id": "theopolis.investigations.perspectives.create", "method": "POST", "pathTemplate": "investigations/perspectives", "stability": "stable", "summary": "Create investigation perspective", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new perspective definition for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationPerspectiveCreate", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the perspective" }, "description": { "type": "string", "description": "Optional description of the perspective", "nullable": true }, "measurements": { "type": "array", "description": "Array of measurement definitions", "items": { "ref": "#/components/schemas/Measurement", "type": "object", "required": [ "id", "name", "description", "shouldBeSummed" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the measurement" }, "name": { "type": "string", "description": "The name of the measurement" }, "description": { "type": "string", "description": "Description of what this measurement tracks" }, "shouldBeSummed": { "type": "boolean", "description": "Whether this measurement should be summed/aggregated" } } } }, "categories": { "type": "array", "description": "Array of category definitions with measurement values", "items": { "ref": "#/components/schemas/Category", "type": "object", "required": [ "id", "name", "description", "values" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the category" }, "name": { "type": "string", "description": "The name of the category" }, "description": { "type": "string", "description": "Description of this category" }, "values": { "type": "object", "description": "Measurement UUID to numeric value mapping for this category", "additionalProperties": { "type": "number", "truncated": true } } } } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationPerspective", "type": "object", "required": [ "id", "organizationId", "name", "measurements", "categories", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the perspective" }, "description": { "type": "string", "description": "Optional description of the perspective", "nullable": true }, "measurements": { "type": "array", "description": "Array of measurement definitions", "items": { "ref": "#/components/schemas/Measurement", "type": "object", "required": [ "id", "name", "description", "shouldBeSummed" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the measurement", "truncated": true }, "name": { "type": "string", "description": "The name of the measurement", "truncated": true }, "description": { "type": "string", "description": "Description of what this measurement tracks", "truncated": true }, "shouldBeSummed": { "type": "boolean", "description": "Whether this measurement should be summed/aggregated", "truncated": true } } } }, "categories": { "type": "array", "description": "Array of category definitions with measurement values", "items": { "ref": "#/components/schemas/Category", "type": "object", "required": [ "id", "name", "description", "values" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the category", "truncated": true }, "name": { "type": "string", "description": "The name of the category", "truncated": true }, "description": { "type": "string", "description": "Description of this category", "truncated": true }, "values": { "type": "object", "description": "Measurement UUID to numeric value mapping for this category", "truncated": true } } } }, "isEnabled": { "type": "boolean", "description": "Whether the perspective is enabled or disabled" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives" } }, { "id": "theopolis.investigations.perspectives.delete", "method": "DELETE", "pathTemplate": "investigations/perspectives/{id}", "stability": "stable", "summary": "Delete investigation perspective", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete a perspective definition", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the perspective", "location": "path", "name": "perspectiveId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Perspective deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives/{perspectiveId}" } }, { "id": "theopolis.investigations.perspectives.get", "method": "GET", "pathTemplate": "investigations/perspectives/{id}", "stability": "stable", "summary": "Get investigation perspective", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific perspective definition by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the perspective", "location": "path", "name": "perspectiveId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationPerspective", "type": "object", "required": [ "id", "organizationId", "name", "measurements", "categories", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the perspective" }, "description": { "type": "string", "description": "Optional description of the perspective", "nullable": true }, "measurements": { "type": "array", "description": "Array of measurement definitions", "items": { "ref": "#/components/schemas/Measurement", "type": "object", "required": [ "id", "name", "description", "shouldBeSummed" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the measurement", "truncated": true }, "name": { "type": "string", "description": "The name of the measurement", "truncated": true }, "description": { "type": "string", "description": "Description of what this measurement tracks", "truncated": true }, "shouldBeSummed": { "type": "boolean", "description": "Whether this measurement should be summed/aggregated", "truncated": true } } } }, "categories": { "type": "array", "description": "Array of category definitions with measurement values", "items": { "ref": "#/components/schemas/Category", "type": "object", "required": [ "id", "name", "description", "values" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the category", "truncated": true }, "name": { "type": "string", "description": "The name of the category", "truncated": true }, "description": { "type": "string", "description": "Description of this category", "truncated": true }, "values": { "type": "object", "description": "Measurement UUID to numeric value mapping for this category", "truncated": true } } } }, "isEnabled": { "type": "boolean", "description": "Whether the perspective is enabled or disabled" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives/{perspectiveId}" } }, { "id": "theopolis.investigations.perspectives.list", "method": "GET", "pathTemplate": "investigations/perspectives", "stability": "stable", "summary": "List investigation perspectives", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all perspective definitions for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/InvestigationPerspective", "type": "object", "required": [ "id", "organizationId", "name", "measurements", "categories", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of investigation perspectives", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives" } }, { "id": "theopolis.investigations.perspectives.summary", "method": "GET", "pathTemplate": "investigations/perspectives/summary", "stability": "stable", "summary": "Get investigation perspectives summary", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve an executive summary combining analytics from all perspectives for the last week, formatted as markdown", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "summary" ], "properties": { "summary": { "type": "string", "description": "Markdown-formatted executive summary of all perspectives' analytics from the last week" } } } } }, "contentTypes": [ "application/json" ], "description": "Executive summary generated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives/summary" } }, { "id": "theopolis.investigations.perspectives.update", "method": "PATCH", "pathTemplate": "investigations/perspectives/{id}", "stability": "stable", "summary": "Update investigation perspective", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing perspective definition", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the perspective", "location": "path", "name": "perspectiveId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationPerspectiveUpdate", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the perspective" }, "description": { "type": "string", "description": "Optional description of the perspective", "nullable": true }, "measurements": { "type": "array", "description": "Array of measurement definitions", "items": { "ref": "#/components/schemas/Measurement", "type": "object", "required": [ "id", "name", "description", "shouldBeSummed" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the measurement" }, "name": { "type": "string", "description": "The name of the measurement" }, "description": { "type": "string", "description": "Description of what this measurement tracks" }, "shouldBeSummed": { "type": "boolean", "description": "Whether this measurement should be summed/aggregated" } } } }, "categories": { "type": "array", "description": "Array of category definitions with measurement values", "items": { "ref": "#/components/schemas/Category", "type": "object", "required": [ "id", "name", "description", "values" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the category" }, "name": { "type": "string", "description": "The name of the category" }, "description": { "type": "string", "description": "Description of this category" }, "values": { "type": "object", "description": "Measurement UUID to numeric value mapping for this category", "additionalProperties": { "type": "number", "truncated": true } } } } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationPerspective", "type": "object", "required": [ "id", "organizationId", "name", "measurements", "categories", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The name of the perspective" }, "description": { "type": "string", "description": "Optional description of the perspective", "nullable": true }, "measurements": { "type": "array", "description": "Array of measurement definitions", "items": { "ref": "#/components/schemas/Measurement", "type": "object", "required": [ "id", "name", "description", "shouldBeSummed" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the measurement", "truncated": true }, "name": { "type": "string", "description": "The name of the measurement", "truncated": true }, "description": { "type": "string", "description": "Description of what this measurement tracks", "truncated": true }, "shouldBeSummed": { "type": "boolean", "description": "Whether this measurement should be summed/aggregated", "truncated": true } } } }, "categories": { "type": "array", "description": "Array of category definitions with measurement values", "items": { "ref": "#/components/schemas/Category", "type": "object", "required": [ "id", "name", "description", "values" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the category", "truncated": true }, "name": { "type": "string", "description": "The name of the category", "truncated": true }, "description": { "type": "string", "description": "Description of this category", "truncated": true }, "values": { "type": "object", "description": "Measurement UUID to numeric value mapping for this category", "truncated": true } } } }, "isEnabled": { "type": "boolean", "description": "Whether the perspective is enabled or disabled" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Perspective not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis-legacy.json", "sourcePath": "/investigations/perspectives/{perspectiveId}" } }, { "id": "theopolis.investigations.stats", "method": "POST", "pathTemplate": "investigations/stats", "stability": "stable", "summary": "Get investigation stats", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve aggregated statistics for investigations within a time range, including total counts, completion status, and human intervention metrics", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "startTime", "endTime" ], "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start of the time range (ISO 8601 datetime)" }, "endTime": { "type": "string", "format": "date-time", "description": "End of the time range (ISO 8601 datetime)" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "totalInvestigations", "completedInvestigations", "completedWithoutHumanIntervention", "completedWithHumanIntervention", "activeInvestigations", "activeAwaitingApproval", "eventTriggeredInvestigations", "scheduleTriggeredInvestigations", "slackTriggeredInvestigations", "manualTriggeredInvestigations", "InvestigationPositiveFeedbackCount", "InvestigationNegativeFeedbackCount" ], "properties": { "totalInvestigations": { "type": "integer", "description": "Total number of investigations (all TaskFlowRuns linked to investigations)" }, "completedInvestigations": { "type": "integer", "description": "Number of completed investigations (have end_result event)" }, "completedWithoutHumanIntervention": { "type": "integer", "description": "Number of AI-completed investigations (no taskflow_paused events)" }, "completedWithHumanIntervention": { "type": "integer", "description": "Number of investigations completed with human in the loop (has taskflow_paused events)" }, "activeInvestigations": { "type": "integer", "description": "Number of active/running investigations (no end_result event)" }, "activeAwaitingApproval": { "type": "integer", "description": "Number of active investigations waiting for human approval (last event is taskflow_paused)" }, "eventTriggeredInvestigations": { "type": "integer", "description": "Number of investigations triggered by events" }, "scheduleTriggeredInvestigations": { "type": "integer", "description": "Number of investigations triggered by schedule" }, "slackTriggeredInvestigations": { "type": "integer", "description": "Number of investigations triggered by Slack" }, "manualTriggeredInvestigations": { "type": "integer", "description": "Number of manually triggered investigations" }, "InvestigationPositiveFeedbackCount": { "type": "integer", "description": "Number of investigations with positive feedback (vote = 1), filtered by TaskFlowRun creation time" }, "InvestigationNegativeFeedbackCount": { "type": "integer", "description": "Number of investigations with negative feedback (vote = -1), filtered by TaskFlowRun creation time" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation statistics retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid parameters", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/stats" } }, { "id": "theopolis.investigations.taskflow-run.get", "method": "GET", "pathTemplate": "investigations/{investigationId}/taskflow-run", "stability": "stable", "summary": "Get investigation taskflow run", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve the most recent taskflow run (taskflowRunId and taskflowId) associated with a specific investigation", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "taskflowRunId", "taskflowId", "status", "createdAt", "updatedAt" ], "properties": { "taskflowRunId": { "type": "string", "format": "uuid", "description": "The ID of the taskflow run" }, "taskflowId": { "type": "string", "format": "uuid", "description": "The ID of the taskflow" }, "status": { "type": "string", "description": "Current status of the task flow run", "enum": [ "running", "waiting_approval", "paused", "completed", "failed" ] }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the taskflow run was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the taskflow run was last updated" } } } } }, "contentTypes": [ "application/json" ], "description": "TaskFlow run information for the investigation", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found or no taskflow run associated with this investigation", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}/taskflow-run" } }, { "id": "theopolis.investigations.transitions.get", "method": "GET", "pathTemplate": "investigations/{investigationId}/transitions", "stability": "stable", "summary": "Get investigation transitions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve the history of column transitions for a specific investigation", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/InvestigationColumnTransition", "type": "object", "required": [ "id", "organizationId", "investigationId", "toBoardColumnId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "truncated": true }, "investigationId": { "type": "string", "format": "uuid", "truncated": true }, "fromBoardColumnId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "toBoardColumnId": { "type": "string", "format": "uuid", "truncated": true }, "createdBy": { "type": "string", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of transitions for the investigation", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}/transitions" } }, { "id": "theopolis.investigations.update", "method": "PATCH", "pathTemplate": "investigations/{investigationId}", "stability": "stable", "summary": "Update investigation", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update specific fields of an existing investigation", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the investigation", "location": "path", "name": "investigationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/InvestigationPatch", "type": "object", "properties": { "boardColumnId": { "type": "string", "format": "uuid", "description": "The board column ID to move the investigation to" }, "name": { "type": "string", "description": "The name of the investigation" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Investigation", "type": "object", "required": [ "id", "organizationId", "signalId", "name", "isArchived", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "signalId": { "type": "string" }, "boardColumnId": { "type": "string", "format": "uuid", "description": "The board column this investigation is in. Can be null for investigations not placed on boards (e.g., taskflow-generated investigations).", "nullable": true }, "name": { "type": "string" }, "isArchived": { "type": "boolean", "description": "Indicates whether the investigation is archived" }, "isTest": { "type": "boolean", "description": "Indicates if this is a test investigation that should not appear on boards" }, "parentInvestigationId": { "type": "string", "format": "uuid", "description": "The ID of the parent investigation if this is a sub-investigation" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "details": { "type": "object", "description": "Optional detailed information included when details=true query parameter is used", "properties": { "signal": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "threadId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true, "truncated": true }, "goal": { "type": "string", "truncated": true }, "model": { "type": "string", "nullable": true, "truncated": true }, "scheduleCron": { "type": "string", "nullable": true, "truncated": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ], "truncated": true }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "truncated": true }, "result": { "type": "string", "nullable": true, "truncated": true }, "summarySoFar": { "type": "string", "nullable": true, "truncated": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards", "truncated": true }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ], "truncated": true }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true, "truncated": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true, "truncated": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true, "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true, "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } }, "tasks": { "type": "array", "description": "All tasks associated with this investigation", "items": { "type": "object", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Investigation not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/investigations/{investigationId}" } }, { "id": "theopolis.mcp.connections.create", "method": "POST", "pathTemplate": "mcp/connections", "stability": "stable", "summary": "Create MCP connection", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.connections.delete", "method": "DELETE", "pathTemplate": "mcp/connections/{connectionId}", "stability": "stable", "summary": "Delete MCP connection", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.connections.get", "method": "GET", "pathTemplate": "mcp/connections/{connectionId}", "stability": "stable", "summary": "Get MCP connection", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.connections.list", "method": "GET", "pathTemplate": "mcp/connections", "stability": "stable", "summary": "List MCP connections", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.connections.update", "method": "PATCH", "pathTemplate": "mcp/connections/{connectionId}", "stability": "stable", "summary": "Update MCP connection", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.create", "method": "POST", "pathTemplate": "mcp/tools", "stability": "stable", "summary": "Create persona tool", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.delete", "method": "DELETE", "pathTemplate": "mcp/tools/{toolId}", "stability": "stable", "summary": "Delete persona tool", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.execute", "method": "POST", "pathTemplate": "mcp/tools/{toolId}/execute", "stability": "stable", "summary": "Execute persona tool", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.generate", "method": "POST", "pathTemplate": "mcp/tools/generate", "stability": "stable", "summary": "Generate persona tool", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.get", "method": "GET", "pathTemplate": "mcp/tools/{toolId}", "stability": "stable", "summary": "Get persona tool", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.list", "method": "GET", "pathTemplate": "mcp/tools", "stability": "stable", "summary": "List persona tools", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.mcp.tools.update", "method": "PATCH", "pathTemplate": "mcp/tools/{toolId}", "stability": "stable", "summary": "Update persona tool", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.model-providers.delete", "method": "DELETE", "pathTemplate": "model-providers/{provider}", "stability": "stable", "summary": "Delete model provider", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Deleted", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/model-providers/{name}" } }, { "id": "theopolis.model-providers.get", "method": "GET", "pathTemplate": "model-providers/{provider}", "stability": "stable", "summary": "Get model provider", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Config (masked)", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": {}, "contentTypes": [], "description": "Not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/model-providers/{name}" } }, { "id": "theopolis.model-providers.list", "method": "GET", "pathTemplate": "model-providers", "stability": "stable", "summary": "List model providers", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "List bring-your-own-model configs for the org (config masked).", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "truncated": true }, "name": { "type": "string", "truncated": true }, "provider": { "type": "string", "truncated": true }, "config": { "type": "object", "truncated": true }, "createdAt": { "type": "string", "truncated": true }, "updatedAt": { "type": "string", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of configs", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/model-providers" } }, { "id": "theopolis.model-providers.put", "method": "PUT", "pathTemplate": "model-providers/{provider}", "stability": "stable", "summary": "Create or update model provider", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.notification-destinations.create", "method": "POST", "pathTemplate": "notification-destinations", "stability": "stable", "summary": "Create a notification destination", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new notification destination where investigation notifications will be sent", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "platform", "destinationId", "destinationName" ], "properties": { "platform": { "type": "string", "description": "The notification platform", "enum": [ "slack", "teams", "sms" ] }, "destinationId": { "type": "string", "description": "The Slack/Teams channel ID or phone number (E.164 format)" }, "destinationName": { "type": "string", "description": "Human-readable destination name" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "destination": { "ref": "#/components/schemas/NotificationDestination", "type": "object", "required": [ "id", "organizationId", "platform", "destinationId", "destinationName", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "platform": { "type": "string", "description": "The notification platform", "enum": [ "slack", "teams", "sms" ] }, "destinationId": { "type": "string", "description": "The Slack/Teams channel ID or phone number (E.164 format)" }, "destinationName": { "type": "string", "description": "Human-readable destination name" }, "isEnabled": { "type": "boolean", "description": "Whether the destination is active" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Notification destination created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Invalid request body", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Destination already exists for this platform", "statusCode": "409" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/notification-destinations" } }, { "id": "theopolis.notification-destinations.delete", "method": "DELETE", "pathTemplate": "notification-destinations/{destinationId}", "stability": "stable", "summary": "Delete a notification destination", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete (soft delete) a notification destination", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The notification destination ID", "location": "path", "name": "destinationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "Notification destination deleted successfully", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Notification destination not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/notification-destinations/{destinationId}" } }, { "id": "theopolis.notification-destinations.get", "method": "GET", "pathTemplate": "notification-destinations/{destinationId}", "stability": "stable", "summary": "Get a notification destination", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific notification destination", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The notification destination ID", "location": "path", "name": "destinationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "destination": { "ref": "#/components/schemas/NotificationDestination", "type": "object", "required": [ "id", "organizationId", "platform", "destinationId", "destinationName", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "platform": { "type": "string", "description": "The notification platform", "enum": [ "slack", "teams", "sms" ] }, "destinationId": { "type": "string", "description": "The Slack/Teams channel ID or phone number (E.164 format)" }, "destinationName": { "type": "string", "description": "Human-readable destination name" }, "isEnabled": { "type": "boolean", "description": "Whether the destination is active" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Notification destination details", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Notification destination not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/notification-destinations/{destinationId}" } }, { "id": "theopolis.notification-destinations.list", "method": "GET", "pathTemplate": "notification-destinations", "stability": "stable", "summary": "List notification destinations", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all notification destinations for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Filter by platform (optional)", "location": "query", "name": "platform", "required": false, "schema": { "type": "string", "enum": [ "slack", "teams", "sms" ] } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "ref": "#/components/schemas/NotificationDestination", "type": "object", "required": [ "id", "organizationId", "platform", "destinationId", "destinationName", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "platform": { "type": "string", "description": "The notification platform", "enum": [ "slack", "teams", "sms" ], "truncated": true }, "destinationId": { "type": "string", "description": "The Slack/Teams channel ID or phone number (E.164 format)", "truncated": true }, "destinationName": { "type": "string", "description": "Human-readable destination name", "truncated": true }, "isEnabled": { "type": "boolean", "description": "Whether the destination is active", "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "updatedBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of notification destinations", "statusCode": "200" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/notification-destinations" } }, { "id": "theopolis.notification-destinations.update", "method": "PUT", "pathTemplate": "notification-destinations/{destinationId}", "stability": "stable", "summary": "Update a notification destination", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing notification destination", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The notification destination ID", "location": "path", "name": "destinationId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "slack", "teams", "sms" ] }, "destinationId": { "type": "string" }, "destinationName": { "type": "string" }, "isEnabled": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "destination": { "ref": "#/components/schemas/NotificationDestination", "type": "object", "required": [ "id", "organizationId", "platform", "destinationId", "destinationName", "isEnabled", "createdBy", "updatedBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "platform": { "type": "string", "description": "The notification platform", "enum": [ "slack", "teams", "sms" ] }, "destinationId": { "type": "string", "description": "The Slack/Teams channel ID or phone number (E.164 format)" }, "destinationName": { "type": "string", "description": "Human-readable destination name" }, "isEnabled": { "type": "boolean", "description": "Whether the destination is active" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Notification destination updated successfully", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Notification destination not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/notification-destinations/{destinationId}" } }, { "id": "theopolis.principles.create", "method": "POST", "pathTemplate": "principles", "stability": "stable", "summary": "Create a principle", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new principle for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PrincipleCreate", "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Principle", "type": "object", "required": [ "id", "message", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "message": { "type": "string" }, "isEnabled": { "type": "boolean" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Principle created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/principles" } }, { "id": "theopolis.principles.delete", "method": "DELETE", "pathTemplate": "principles/{principleId}", "stability": "stable", "summary": "Delete a principle", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete a principle (sets isEnabled to false)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The principle ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Principle deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Principle not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/principles/{id}" } }, { "id": "theopolis.principles.get", "method": "GET", "pathTemplate": "principles/{principleId}", "stability": "stable", "summary": "Get a principle", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific principle by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The principle ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Principle", "type": "object", "required": [ "id", "message", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "message": { "type": "string" }, "isEnabled": { "type": "boolean" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Principle found", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Principle not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/principles/{id}" } }, { "id": "theopolis.principles.list", "method": "GET", "pathTemplate": "principles", "stability": "stable", "summary": "List principles", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all principles for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Principle", "type": "object", "required": [ "id", "message", "organizationId", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of principles", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/principles" } }, { "id": "theopolis.principles.update", "method": "PATCH", "pathTemplate": "principles/{principleId}", "stability": "stable", "summary": "Update a principle", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing principle", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The principle ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/PrincipleUpdate", "type": "object", "properties": { "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Principle", "type": "object", "required": [ "id", "message", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "message": { "type": "string" }, "isEnabled": { "type": "boolean" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Principle updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Principle not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/principles/{id}" } }, { "id": "theopolis.signals.count", "method": "POST", "pathTemplate": "signals/count", "stability": "stable", "summary": "Count signals", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get counts of signals grouped by type (manual, eventTrigger, schedule, slack) filtered by time range.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start time for filtering signals (ISO 8601 datetime). Optional." }, "endTime": { "type": "string", "format": "date-time", "description": "End time for filtering signals (ISO 8601 datetime). Optional." } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "counts" ], "properties": { "counts": { "type": "object", "description": "Counts of signals by type", "required": [ "manual", "eventTrigger", "schedule", "slack", "total" ], "properties": { "manual": { "type": "integer", "description": "Count of manual signals" }, "eventTrigger": { "type": "integer", "description": "Count of eventTrigger signals" }, "schedule": { "type": "integer", "description": "Count of schedule signals" }, "slack": { "type": "integer", "description": "Count of slack signals" }, "total": { "type": "integer", "description": "Total count of all signals" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Signal counts by type", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid time range", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/count" } }, { "id": "theopolis.signals.create", "method": "POST", "pathTemplate": "signals", "stability": "stable", "summary": "Create a signal", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new signal for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SignalCreate", "type": "object", "required": [ "goal" ], "properties": { "threadId": { "type": "string", "format": "uuid", "nullable": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true }, "goal": { "type": "string" }, "model": { "type": "string", "nullable": true }, "scheduleCron": { "type": "string", "nullable": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ] }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ] }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "threadId": { "type": "string", "format": "uuid", "nullable": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true }, "goal": { "type": "string" }, "model": { "type": "string", "nullable": true }, "scheduleCron": { "type": "string", "nullable": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ] }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ] }, "result": { "type": "string", "nullable": true }, "summarySoFar": { "type": "string", "nullable": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards" }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ] }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals" } }, { "id": "theopolis.signals.delete", "method": "DELETE", "pathTemplate": "signals/{signalId}", "stability": "stable", "summary": "Delete signal", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete an existing signal", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the signal", "location": "path", "name": "signalId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Signal deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/{signalId}" } }, { "id": "theopolis.signals.get", "method": "GET", "pathTemplate": "signals/{signalId}", "stability": "stable", "summary": "Get a signal", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific signal by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the signal", "location": "path", "name": "signalId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "threadId": { "type": "string", "format": "uuid", "nullable": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true }, "goal": { "type": "string" }, "model": { "type": "string", "nullable": true }, "scheduleCron": { "type": "string", "nullable": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ] }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ] }, "result": { "type": "string", "nullable": true }, "summarySoFar": { "type": "string", "nullable": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards" }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ] }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/{signalId}" } }, { "id": "theopolis.signals.list", "method": "GET", "pathTemplate": "signals", "stability": "stable", "summary": "List signals", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all signals for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of signals", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals" } }, { "id": "theopolis.signals.query", "method": "POST", "pathTemplate": "signals/query", "stability": "stable", "summary": "Query signals by filter", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Query signals filtered by time range and optionally by type. Returns signals ordered by startTime ascending.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SignalQueryFilter", "type": "object", "required": [ "startTime" ], "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start time for filtering signals (ISO 8601 datetime). Required." }, "endTime": { "type": "string", "format": "date-time", "description": "End time for filtering signals (ISO 8601 datetime). If not provided, defaults to current time." }, "type": { "type": "string", "description": "Optional signal type to filter by", "enum": [ "manual", "eventTrigger", "schedule", "slack" ] } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "Array of signals matching the query, ordered by startTime ascending", "items": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "threadId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true, "truncated": true }, "goal": { "type": "string", "truncated": true }, "model": { "type": "string", "nullable": true, "truncated": true }, "scheduleCron": { "type": "string", "nullable": true, "truncated": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ], "truncated": true }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "truncated": true }, "result": { "type": "string", "nullable": true, "truncated": true }, "summarySoFar": { "type": "string", "nullable": true, "truncated": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards", "truncated": true }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ], "truncated": true }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true, "truncated": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true, "truncated": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true, "truncated": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true, "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of signals matching the query", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid time range or filter parameters", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/query" } }, { "id": "theopolis.signals.references.add", "method": "POST", "pathTemplate": "signals/{signalId}/references", "stability": "stable", "summary": "Add signal references", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a reference between a signal and another entity (e.g., alarm)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The ID of the signal", "location": "path", "name": "signalId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SignalReferenceCreate", "type": "object", "required": [ "signalId", "referenceType", "referenceId" ], "properties": { "signalId": { "type": "string" }, "referenceType": { "type": "string", "enum": [ "alarm" ] }, "referenceId": { "type": "string", "format": "uuid" }, "investigationId": { "type": "string", "format": "uuid", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SignalReference", "type": "object", "required": [ "id", "organizationId", "signalId", "referenceType", "referenceId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "signalId": { "type": "string" }, "referenceType": { "type": "string", "enum": [ "alarm" ] }, "referenceId": { "type": "string", "format": "uuid" }, "investigationId": { "type": "string", "format": "uuid", "nullable": true }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal reference created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/{signalId}/references" } }, { "id": "theopolis.signals.trigger", "method": "POST", "pathTemplate": "signals/{signalId}/trigger", "stability": "stable", "summary": "Trigger signal", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Trigger a signal for execution", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the signal to trigger", "location": "path", "name": "signalId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal triggered successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/{signalId}/trigger" } }, { "id": "theopolis.signals.update", "method": "PUT", "pathTemplate": "signals/{signalId}", "stability": "stable", "summary": "Update signal", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing signal", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the signal", "location": "path", "name": "signalId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SignalCreate", "type": "object", "required": [ "goal" ], "properties": { "threadId": { "type": "string", "format": "uuid", "nullable": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true }, "goal": { "type": "string" }, "model": { "type": "string", "nullable": true }, "scheduleCron": { "type": "string", "nullable": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ] }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ] }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Signal", "type": "object", "required": [ "id", "goal", "status", "type", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "threadId": { "type": "string", "format": "uuid", "nullable": true }, "personaId": { "type": "string", "format": "uuid", "description": "The persona ID to use for the signal. Can be null for taskflow investigations.", "nullable": true }, "goal": { "type": "string" }, "model": { "type": "string", "nullable": true }, "scheduleCron": { "type": "string", "nullable": true }, "thinkingEffort": { "type": "string", "enum": [ "high", "medium", "low", "none" ] }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ] }, "result": { "type": "string", "nullable": true }, "summarySoFar": { "type": "string", "nullable": true }, "insightId": { "type": "string", "format": "uuid", "nullable": true }, "eventTriggerId": { "type": "string", "format": "uuid", "nullable": true }, "eventId": { "type": "string", "format": "uuid", "nullable": true }, "isTest": { "type": "boolean", "description": "Indicates if this is a test signal that should not appear on boards" }, "type": { "type": "string", "description": "The type of signal", "enum": [ "manual", "eventTrigger", "schedule", "slack" ] }, "scheduleId": { "type": "string", "format": "uuid", "description": "The schedule ID associated with this signal (for schedule type signals)", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the signal event", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "description": "End time of the signal event", "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "description": "The device ID associated with this signal", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Signal not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/signals/{signalId}" } }, { "id": "theopolis.suggestions.count", "method": "GET", "pathTemplate": "suggestions/count", "stability": "stable", "summary": "Count pending suggestions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get the count of suggestions that have at least one pending item. Optionally filter by taskFlowId.", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Optional TaskFlow ID to filter suggestions by", "location": "query", "name": "taskFlowId", "required": false, "schema": { "type": "string", "format": "uuid" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "count" ], "properties": { "count": { "type": "integer", "description": "Number of suggestions with pending items" } } } } }, "contentTypes": [ "application/json" ], "description": "Count retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/suggestions/count" } }, { "id": "theopolis.suggestions.delete", "method": "DELETE", "pathTemplate": "suggestions/delete/{suggestionId}", "stability": "stable", "summary": "Delete a suggestion", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete a suggestion and all its items", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Suggestion ID", "location": "path", "name": "suggestionId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Suggestion deleted successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Suggestion not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/suggestions/delete/{suggestionId}" } }, { "id": "theopolis.suggestions.generate", "method": "POST", "pathTemplate": "suggestions/{taskFlowId}/generate", "stability": "stable", "summary": "Generate taskflow suggestions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Generate new AI-powered suggestions for a specific taskflow based on feedback from all investigations using it. This is a long-running operation that streams the response.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "TaskFlow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "text/event-stream": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "suggestion": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "summary": { "type": "string" }, "taskFlowId": { "type": "string", "format": "uuid" } } }, "items": { "type": "array", "items": { "ref": "#/components/schemas/SuggestionItem", "type": "object", "required": [ "id", "organizationId", "suggestionId", "value", "type", "reasoning", "relatedFeedbacks", "status", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "suggestionId": { "type": "string", "format": "uuid", "truncated": true }, "type": { "type": "string", "description": "Type of suggestion: mandate (best practice), guardrail (avoid this), or goal (objective)", "enum": [ "mandate", "guardrail", "goal" ], "truncated": true }, "value": { "type": "string", "description": "The actual suggestion value: For mandate/guardrail - the rule text. For goal - the target/desired state", "truncated": true }, "oldValue": { "type": "string", "description": "Optional: Previous value. Typically used for goals to show change from current state to desired state", "nullable": true, "truncated": true }, "reasoning": { "type": "string", "description": "Detailed explanation of why this suggestion is being made", "truncated": true }, "relatedFeedbacks": { "type": "array", "description": "Array of InvestigationFeedback IDs that support this suggestion", "items": { "type": "string", "format": "uuid", "truncated": true }, "truncated": true }, "status": { "type": "string", "description": "Status of the suggestion item", "enum": [ "pending", "approved", "rejected" ], "truncated": true }, "metadata": { "type": "object", "description": "Additional metadata for the suggestion. For goals, may contain nodeId of the AI node this suggestion relates to", "truncated": true }, "isEnabled": { "type": "boolean", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "text/event-stream" ], "description": "Suggestions generated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Failed to generate suggestions", "statusCode": "500" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/suggestions/{taskFlowId}/generate" } }, { "id": "theopolis.suggestions.generate-from-version", "method": "POST", "pathTemplate": "suggestions/{taskFlowId}/generate-from-version", "stability": "stable", "summary": "Generate taskflow suggestions from a version", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Generate AI-powered suggestions based on all feedbacks for a specific TaskFlow version. Uses a two-agent workflow: first investigates the feedbacks using tools, then generates structured suggestions.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "TaskFlow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "versionNumber" ], "properties": { "versionNumber": { "type": "integer", "description": "TaskFlow version number" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "suggestionId": { "type": "string", "format": "uuid", "description": "ID of the created suggestion (only if success is true)" }, "itemCount": { "type": "integer", "description": "Number of suggestion items created (only if success is true)" }, "message": { "type": "string", "description": "Message if no suggestions were generated" } } } } }, "contentTypes": [ "application/json" ], "description": "Suggestions generated successfully or no feedbacks found", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Invalid request body or version number", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Failed to generate suggestions", "statusCode": "500" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/suggestions/{taskFlowId}/generate-from-version" } }, { "id": "theopolis.suggestions.list", "method": "GET", "pathTemplate": "suggestions/{taskFlowId}", "stability": "stable", "summary": "List taskflow suggestions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get all AI-generated suggestions for a specific taskflow with their items", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "TaskFlow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "ref": "#/components/schemas/SuggestionWithItems", "allOf": [ { "ref": "#/components/schemas/Suggestion", "type": "object", "required": [ "id", "organizationId", "summary", "createdAt", "updatedAt" ], "truncated": true }, { "type": "object", "truncated": true } ] } } } } } }, "contentTypes": [ "application/json" ], "description": "Suggestions retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/suggestions/{taskFlowId}" } }, { "id": "theopolis.suggestions.status.update", "method": "PATCH", "pathTemplate": "suggestions/status/{itemId}", "stability": "stable", "summary": "Update a suggestion item status", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update the status of a suggestion item (approve, reject, or set back to pending)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Suggestion Item ID", "location": "path", "name": "itemId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "New status for the suggestion item", "enum": [ "pending", "approved", "rejected" ] } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/SuggestionItem", "type": "object", "required": [ "id", "organizationId", "suggestionId", "value", "type", "reasoning", "relatedFeedbacks", "status", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "suggestionId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "Type of suggestion: mandate (best practice), guardrail (avoid this), or goal (objective)", "enum": [ "mandate", "guardrail", "goal" ] }, "value": { "type": "string", "description": "The actual suggestion value: For mandate/guardrail - the rule text. For goal - the target/desired state" }, "oldValue": { "type": "string", "description": "Optional: Previous value. Typically used for goals to show change from current state to desired state", "nullable": true }, "reasoning": { "type": "string", "description": "Detailed explanation of why this suggestion is being made" }, "relatedFeedbacks": { "type": "array", "description": "Array of InvestigationFeedback IDs that support this suggestion", "items": { "type": "string", "format": "uuid" } }, "status": { "type": "string", "description": "Status of the suggestion item", "enum": [ "pending", "approved", "rejected" ] }, "metadata": { "type": "object", "description": "Additional metadata for the suggestion. For goals, may contain nodeId of the AI node this suggestion relates to", "additionalProperties": true }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Status updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Invalid request body", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": {}, "contentTypes": [], "description": "Suggestion item not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/suggestions/status/{itemId}" } }, { "id": "theopolis.taskflows.create", "method": "POST", "pathTemplate": "taskflows", "stability": "stable", "summary": "Create taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new task flow workflow template", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowCreate", "type": "object", "required": [ "name", "graph" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "oneOf": [ { "ref": "#/components/schemas/StartNode", "description": "Start node - entry point that receives initial input and passes it through. Optionally can create an investigation scope for the entire taskflow execution and set a global prompt for all AI operations.", "truncated": true }, { "ref": "#/components/schemas/TaskNode", "description": "Task node - executes a Theopolis agent with specified persona and goal. A Task entity is created for each execution and automatically linked to the current investigation (if one exists in the taskflow scope). Supports optional human-in-the-loop approval via the allowHumanIntervention flag.", "truncated": true }, { "ref": "#/components/schemas/ChoiceNode", "description": "Choice node - evaluates input using AI and selects which edge to follow based on sourceOutputIndex (choice index 0 maps to edge with sourceOutputIndex: 0, etc.). The original input data is passed through unchanged to the selected downstream node.", "truncated": true }, { "ref": "#/components/schemas/EndNode", "description": "End node - uses AI to generate final workflow output based on prompt and accumulated input", "truncated": true }, { "ref": "#/components/schemas/SetColumnNode", "description": "Set column node - updates the investigation's board column and passes through input data unchanged", "truncated": true } ] } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the edge", "truncated": true }, "source": { "type": "string", "description": "ID of the source node", "truncated": true }, "target": { "type": "string", "description": "ID of the target node", "truncated": true }, "label": { "type": "string", "description": "Optional label for the edge (deprecated, use sourceOutputIndex for choice routing)", "truncated": true }, "sourceOutputIndex": { "type": "integer", "description": "Optional index indicating which output of the source node this edge corresponds to (used for choice node routing)", "truncated": true } } } } } }, "isSignalHandler": { "type": "boolean" }, "tags": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlow", "type": "object", "required": [ "id", "organizationId", "name", "graph", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "truncated": true } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "truncated": true } } } }, "isEnabled": { "type": "boolean" }, "isSignalHandler": { "type": "boolean" }, "tags": { "type": "object" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid input", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows" } }, { "id": "theopolis.taskflows.custom-output-fields.create", "method": "POST", "pathTemplate": "taskflows/{taskFlowId}/custom-output-fields", "stability": "stable", "summary": "Create a taskflow custom output field", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Creates a new custom output field that will generate AI-based values when a TaskFlowRun completes. Field name and prompt are immutable after creation.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowCustomOutputFieldCreate", "type": "object", "required": [ "fieldName", "prompt" ], "properties": { "fieldName": { "type": "string", "description": "Name of the custom output field" }, "prompt": { "type": "string", "description": "Prompt used to generate the field value from the execution log" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowCustomOutputField", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "fieldName", "prompt", "isEnabled", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "taskFlowId": { "type": "string", "format": "uuid" }, "fieldName": { "type": "string", "description": "Name of the custom output field" }, "prompt": { "type": "string", "description": "Prompt used to generate the field value from the execution log" }, "isEnabled": { "type": "boolean", "description": "Whether the field is enabled" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Custom output field created", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/custom-output-fields" } }, { "id": "theopolis.taskflows.custom-output-fields.list", "method": "GET", "pathTemplate": "taskflows/{taskFlowId}/custom-output-fields", "stability": "stable", "summary": "List taskflow custom output fields", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Returns all enabled custom output fields configured for the specified taskflow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowCustomOutputField", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "fieldName", "prompt", "isEnabled", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "fieldName": { "type": "string", "description": "Name of the custom output field", "truncated": true }, "prompt": { "type": "string", "description": "Prompt used to generate the field value from the execution log", "truncated": true }, "isEnabled": { "type": "boolean", "description": "Whether the field is enabled", "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of custom output fields", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/custom-output-fields" } }, { "id": "theopolis.taskflows.delete", "method": "DELETE", "pathTemplate": "taskflows/{taskflowId}", "stability": "stable", "summary": "Delete taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft delete a task flow (sets isEnabled to false)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Task flow deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}" } }, { "id": "theopolis.taskflows.eval.ground-truths.create", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/eval/ground-truths", "stability": "stable", "summary": "Create evaluation ground truth for a taskflow signal", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new ground truth for a taskflow.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EvalGroundTruthCreate", "type": "object", "required": [ "signalId", "expectedOutcome", "startTime", "endTime" ], "properties": { "signalId": { "type": "string", "format": "uuid", "description": "Source signal to copy input data from" }, "expectedOutcome": { "type": "string", "description": "Expected result for LLM comparison" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/EvalGroundTruth", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "signalId", "expectedOutcome", "startTime", "endTime", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "taskFlowId": { "type": "string", "format": "uuid" }, "signalId": { "type": "string", "format": "uuid", "description": "Source signal to copy input data from" }, "expectedOutcome": { "type": "string", "description": "Expected result for LLM comparison" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Created ground truth", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/eval/ground-truths" } }, { "id": "theopolis.taskflows.eval.ground-truths.list", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/eval/ground-truths", "stability": "stable", "summary": "List evaluation ground truths for a taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get all ground truths for a taskflow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "groundTruths": { "type": "array", "items": { "ref": "#/components/schemas/EvalGroundTruth", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "signalId", "expectedOutcome", "startTime", "endTime", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "signalId": { "type": "string", "format": "uuid", "description": "Source signal to copy input data from", "truncated": true }, "expectedOutcome": { "type": "string", "description": "Expected result for LLM comparison", "truncated": true }, "startTime": { "type": "string", "format": "date-time", "truncated": true }, "endTime": { "type": "string", "format": "date-time", "truncated": true }, "isEnabled": { "type": "boolean", "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of ground truths", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/eval/ground-truths" } }, { "id": "theopolis.taskflows.eval.runs.list", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/eval/runs", "stability": "stable", "summary": "List evaluation runs for a taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get all eval runs for a taskflow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": null, "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "runs": { "type": "array", "items": { "ref": "#/components/schemas/EvalRun", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "taskFlowVersionNumber", "status", "totalSignals", "completedSignals", "passedSignals", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowVersionNumber": { "type": "integer", "truncated": true }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ], "truncated": true }, "totalSignals": { "type": "integer", "truncated": true }, "completedSignals": { "type": "integer", "truncated": true }, "passedSignals": { "type": "integer", "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of eval runs", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/eval/runs" } }, { "id": "theopolis.taskflows.execute", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/execute", "stability": "stable", "summary": "Execute taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Execute a task flow graph asynchronously. Returns immediately with a taskFlowRunId that can be used to listen to execution events via the listen endpoint.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowRequest", "type": "object", "required": [ "graph", "input" ], "properties": { "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "oneOf": [ { "ref": "#/components/schemas/StartNode", "description": "Start node - entry point that receives initial input and passes it through. Optionally can create an investigation scope for the entire taskflow execution and set a global prompt for all AI operations.", "truncated": true }, { "ref": "#/components/schemas/TaskNode", "description": "Task node - executes a Theopolis agent with specified persona and goal. A Task entity is created for each execution and automatically linked to the current investigation (if one exists in the taskflow scope). Supports optional human-in-the-loop approval via the allowHumanIntervention flag.", "truncated": true }, { "ref": "#/components/schemas/ChoiceNode", "description": "Choice node - evaluates input using AI and selects which edge to follow based on sourceOutputIndex (choice index 0 maps to edge with sourceOutputIndex: 0, etc.). The original input data is passed through unchanged to the selected downstream node.", "truncated": true }, { "ref": "#/components/schemas/EndNode", "description": "End node - uses AI to generate final workflow output based on prompt and accumulated input", "truncated": true }, { "ref": "#/components/schemas/SetColumnNode", "description": "Set column node - updates the investigation's board column and passes through input data unchanged", "truncated": true } ] } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the edge", "truncated": true }, "source": { "type": "string", "description": "ID of the source node", "truncated": true }, "target": { "type": "string", "description": "ID of the target node", "truncated": true }, "label": { "type": "string", "description": "Optional label for the edge (deprecated, use sourceOutputIndex for choice routing)", "truncated": true }, "sourceOutputIndex": { "type": "integer", "description": "Optional index indicating which output of the source node this edge corresponds to (used for choice node routing)", "truncated": true } } } } } }, "input": { "type": "string", "description": "Initial input to the workflow" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskFlowRunId": { "type": "string", "format": "uuid", "description": "ID of the task flow run that can be used to listen to events" }, "signalId": { "type": "string", "format": "uuid", "description": "ID of the signal associated with this task flow run" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow execution accepted and started", "statusCode": "202" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid graph structure", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/execute" } }, { "id": "theopolis.taskflows.filters.create", "method": "POST", "pathTemplate": "taskflows/{taskFlowId}/filters", "stability": "stable", "summary": "Create a taskflow filter", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new filter with time range and event trigger IDs for a task flow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowFilterCreate", "type": "object", "required": [ "startTime", "endTime", "eventTriggerIds" ], "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Start time for the filter" }, "endTime": { "type": "string", "format": "date-time", "description": "End time for the filter" }, "eventTriggerIds": { "type": "array", "description": "Array of event trigger IDs", "items": { "type": "string" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowFilter", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "startTime", "endTime", "eventTriggerIds", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "taskFlowId": { "type": "string", "format": "uuid" }, "startTime": { "type": "string", "format": "date-time", "description": "Start time for the filter" }, "endTime": { "type": "string", "format": "date-time", "description": "End time for the filter" }, "eventTriggerIds": { "type": "array", "description": "Array of event trigger IDs", "items": { "type": "string" } }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Filter created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid input", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/filters" } }, { "id": "theopolis.taskflows.filters.list", "method": "GET", "pathTemplate": "taskflows/{taskFlowId}/filters", "stability": "stable", "summary": "List taskflow filters", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all filters for a specific task flow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowFilter", "type": "object", "required": [ "id", "organizationId", "taskFlowId", "startTime", "endTime", "eventTriggerIds", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "taskFlowId": { "type": "string", "format": "uuid" }, "startTime": { "type": "string", "format": "date-time", "description": "Start time for the filter" }, "endTime": { "type": "string", "format": "date-time", "description": "End time for the filter" }, "eventTriggerIds": { "type": "array", "description": "Array of event trigger IDs", "items": { "type": "string", "truncated": true } }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } }, "contentTypes": [ "application/json" ], "description": "Filters retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/filters" } }, { "id": "theopolis.taskflows.get", "method": "GET", "pathTemplate": "taskflows/{taskflowId}", "stability": "stable", "summary": "Get taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific task flow by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlow", "type": "object", "required": [ "id", "organizationId", "name", "graph", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "truncated": true } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "truncated": true } } } }, "isEnabled": { "type": "boolean" }, "isSignalHandler": { "type": "boolean" }, "tags": { "type": "object" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow retrieved successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}" } }, { "id": "theopolis.taskflows.label-sets.create", "method": "POST", "pathTemplate": "taskflows/label-sets", "stability": "stable", "summary": "Create a taskflow label set", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new label set", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/LabelSet", "type": "object", "required": [ "id", "organizationId", "name", "configuration", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "configuration": { "description": "Configuration for the label set type", "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "feedback" ], "truncated": true } } }, { "type": "object", "required": [ "type", "prompt" ], "properties": { "type": { "type": "string", "enum": [ "llm-as-judge" ], "truncated": true }, "prompt": { "type": "string", "truncated": true } } }, { "type": "object", "required": [ "type", "secondsBeforeStart", "secondsAfterStart" ], "properties": { "type": { "type": "string", "enum": [ "ground-truth" ], "truncated": true }, "secondsBeforeStart": { "type": "number", "description": "Number of seconds before the task flow run start time to include ground truth statements", "truncated": true }, "secondsAfterStart": { "type": "number", "description": "Number of seconds after the task flow run start time to include ground truth statements", "truncated": true } } } ] }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets" } }, { "id": "theopolis.taskflows.label-sets.delete", "method": "DELETE", "pathTemplate": "taskflows/label-sets/{labelSetId}", "stability": "stable", "summary": "Delete a taskflow label set", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete a label set by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the label set", "location": "path", "name": "labelSetId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Label set deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets/{labelSetId}" } }, { "id": "theopolis.taskflows.label-sets.get", "method": "GET", "pathTemplate": "taskflows/label-sets/{labelSetId}", "stability": "stable", "summary": "Get a taskflow label set", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get a specific label set by ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the label set", "location": "path", "name": "labelSetId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/LabelSet", "type": "object", "required": [ "id", "organizationId", "name", "configuration", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "configuration": { "description": "Configuration for the label set type", "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "feedback" ], "truncated": true } } }, { "type": "object", "required": [ "type", "prompt" ], "properties": { "type": { "type": "string", "enum": [ "llm-as-judge" ], "truncated": true }, "prompt": { "type": "string", "truncated": true } } }, { "type": "object", "required": [ "type", "secondsBeforeStart", "secondsAfterStart" ], "properties": { "type": { "type": "string", "enum": [ "ground-truth" ], "truncated": true }, "secondsBeforeStart": { "type": "number", "description": "Number of seconds before the task flow run start time to include ground truth statements", "truncated": true }, "secondsAfterStart": { "type": "number", "description": "Number of seconds after the task flow run start time to include ground truth statements", "truncated": true } } } ] }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets/{labelSetId}" } }, { "id": "theopolis.taskflows.label-sets.items.create", "method": "POST", "pathTemplate": "taskflows/label-sets/{labelSetId}/items", "stability": "stable", "summary": "Create a taskflow label set item", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new item in a label set", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the label set", "location": "path", "name": "labelSetId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "position": { "type": "integer" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/LabelSetItem", "type": "object", "required": [ "id", "organizationId", "labelSetId", "name", "position", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "labelSetId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set item created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets/{labelSetId}/items" } }, { "id": "theopolis.taskflows.label-sets.items.list", "method": "GET", "pathTemplate": "taskflows/label-sets/{labelSetId}/items", "stability": "stable", "summary": "List taskflow label set items", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get all items for a specific label set", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the label set", "location": "path", "name": "labelSetId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "array", "items": { "ref": "#/components/schemas/LabelSetItem", "type": "object", "required": [ "id", "organizationId", "labelSetId", "name", "position", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "labelSetId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "position": { "type": "integer" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } }, "contentTypes": [ "application/json" ], "description": "List of label set items", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets/{labelSetId}/items" } }, { "id": "theopolis.taskflows.label-sets.list", "method": "GET", "pathTemplate": "taskflows/label-sets", "stability": "stable", "summary": "List taskflow label sets", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get all label sets for the organization, optionally including items", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "If true, include all items for each label set", "location": "query", "name": "includeItems", "required": false, "schema": { "type": "boolean" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "array", "items": { "ref": "#/components/schemas/LabelSetWithItems", "allOf": [ { "ref": "#/components/schemas/LabelSet", "type": "object", "required": [ "id", "organizationId", "name", "configuration", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "truncated": true }, "name": { "type": "string", "truncated": true }, "description": { "type": "string", "nullable": true, "truncated": true }, "configuration": { "description": "Configuration for the label set type", "truncated": true }, "isEnabled": { "type": "boolean", "truncated": true }, "createdBy": { "type": "string", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/LabelSetItem", "type": "object", "required": [ "id", "organizationId", "labelSetId", "name", "position", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "truncated": true }, "truncated": true } } } ] } } } }, "contentTypes": [ "application/json" ], "description": "List of label sets", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets" } }, { "id": "theopolis.taskflows.label-sets.update", "method": "PATCH", "pathTemplate": "taskflows/label-sets/{labelSetId}", "stability": "stable", "summary": "Update a taskflow label set", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing label set", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the label set", "location": "path", "name": "labelSetId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/LabelSet", "type": "object", "required": [ "id", "organizationId", "name", "configuration", "isEnabled", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "configuration": { "description": "Configuration for the label set type", "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "feedback" ], "truncated": true } } }, { "type": "object", "required": [ "type", "prompt" ], "properties": { "type": { "type": "string", "enum": [ "llm-as-judge" ], "truncated": true }, "prompt": { "type": "string", "truncated": true } } }, { "type": "object", "required": [ "type", "secondsBeforeStart", "secondsAfterStart" ], "properties": { "type": { "type": "string", "enum": [ "ground-truth" ], "truncated": true }, "secondsBeforeStart": { "type": "number", "description": "Number of seconds before the task flow run start time to include ground truth statements", "truncated": true }, "secondsAfterStart": { "type": "number", "description": "Number of seconds after the task flow run start time to include ground truth statements", "truncated": true } } } ] }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Label set not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/label-sets/{labelSetId}" } }, { "id": "theopolis.taskflows.list", "method": "GET", "pathTemplate": "taskflows", "stability": "stable", "summary": "List taskflows", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all task flows for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Filter task flows by isSignalHandler status. If true, returns only signal handler task flows. If false, returns only non-signal handler task flows. If omitted, returns all task flows.", "location": "query", "name": "isSignalHandler", "required": false, "schema": { "type": "boolean" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlow", "type": "object", "required": [ "id", "organizationId", "name", "graph", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of task flows", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows" } }, { "id": "theopolis.taskflows.runs.execution-log.get", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}/execution-log", "stability": "stable", "summary": "Get taskflow run execution log", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Returns a human-readable formatted log of the entire task flow run execution including all internal choices, reasoning, node inputs/outputs, task messages, tool usage, thread messages (full conversations inside task nodes), end results, and errors. This is useful for debugging, LLM-as-judge evaluations, and understanding what happened during a task flow run.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "Task flow run ID", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskFlowRunId": { "type": "string", "format": "uuid", "description": "Task flow run ID" }, "taskFlowId": { "type": "string", "format": "uuid", "description": "Task flow ID" }, "executionLog": { "type": "string", "description": "Formatted execution log containing all internal execution details including choice thinking, node outputs, task messages, full thread conversations for task nodes (user messages, assistant responses, tool calls, reasoning), tool usage, end results, and errors" } } } } }, "contentTypes": [ "application/json" ], "description": "Formatted execution log", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow run not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}/execution-log" } }, { "id": "theopolis.taskflows.runs.get", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}", "stability": "stable", "summary": "Get taskflow run details", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific task flow run with its events", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "Task flow run ID", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "ref": "#/components/schemas/TaskFlowRun", "type": "object", "description": "Represents an execution instance of a task flow", "required": [ "id", "organizationId", "taskFlowId", "status", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "taskFlowId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "description": "Current status of the task flow run", "enum": [ "running", "waiting_approval", "paused", "cancelled", "completed", "failed" ] }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "investigationId": { "type": "string", "format": "uuid", "description": "Investigation ID associated with this task flow run", "nullable": true }, "investigationName": { "type": "string", "description": "Investigation name associated with this task flow run", "nullable": true }, "feedback": { "type": "array", "description": "Investigation feedback associated with this run (only included when details=true)", "items": { "ref": "#/components/schemas/InvestigationFeedback", "type": "object", "required": [ "id", "investigationId", "userId", "organizationId", "createdAt", "updatedAt" ], "truncated": true } }, "hitl": { "type": "array", "description": "Human-in-the-loop items (approvals and questions) associated with this run (only included when details=true)", "items": { "type": "object", "truncated": true } } } }, "events": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowRunEvent", "type": "object", "description": "Represents an event that occurred during a task flow run execution", "required": [ "id", "organizationId", "taskFlowRunId", "eventType", "createdBy", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowRunId": { "type": "string", "format": "uuid", "truncated": true }, "eventType": { "type": "string", "description": "Type of event that occurred during task flow execution", "truncated": true }, "nodeId": { "type": "string", "description": "ID of the node that generated this event", "nullable": true, "truncated": true }, "data": { "type": "object", "description": "Event data in JSON format", "nullable": true, "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow run with events", "statusCode": "200" }, { "content": {}, "contentTypes": [], "description": "Task flow run not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}" } }, { "id": "theopolis.taskflows.runs.labels.create", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}/labels", "stability": "stable", "summary": "Create labels for taskflow run", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new label for a task flow run", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task flow", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task flow run", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "labelSetItemId" ], "properties": { "labelSetItemId": { "type": "string", "format": "uuid" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowRunLabel", "type": "object", "required": [ "id", "organizationId", "taskFlowRunId", "labelSetItemId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "taskFlowRunId": { "type": "string", "format": "uuid" }, "labelSetItemId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Label created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow run not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}/labels" } }, { "id": "theopolis.taskflows.runs.labels.delete", "method": "DELETE", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}/labels/{labelId}", "stability": "stable", "summary": "Delete label from taskflow run", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete a label by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the label", "location": "path", "name": "labelId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task flow", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task flow run", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Label deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Label not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}/labels/{labelId}" } }, { "id": "theopolis.taskflows.runs.labels.list", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}/labels", "stability": "stable", "summary": "List labels for taskflow run", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get all labels for a specific task flow run", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task flow", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task flow run", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowRunLabel", "type": "object", "required": [ "id", "organizationId", "taskFlowRunId", "labelSetItemId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "taskFlowRunId": { "type": "string", "format": "uuid" }, "labelSetItemId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } } }, "contentTypes": [ "application/json" ], "description": "List of labels", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow run not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}/labels" } }, { "id": "theopolis.taskflows.runs.list", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/runs/paginated", "stability": "stable", "summary": "List taskflow runs", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve task flow runs for a specific task flow with pagination", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [ { "deprecated": false, "description": "Include feedback and HITL data for each run", "location": "query", "name": "details", "required": false, "schema": { "type": "boolean" } }, { "deprecated": false, "description": "Number of items per page", "location": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "deprecated": false, "description": "Number of items to skip", "location": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "runs": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowRun", "type": "object", "description": "Represents an execution instance of a task flow", "required": [ "id", "organizationId", "taskFlowId", "status", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "status": { "type": "string", "description": "Current status of the task flow run", "enum": [ "running", "waiting_approval", "paused", "cancelled", "completed", "failed" ], "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "investigationId": { "type": "string", "format": "uuid", "description": "Investigation ID associated with this task flow run", "nullable": true, "truncated": true }, "investigationName": { "type": "string", "description": "Investigation name associated with this task flow run", "nullable": true, "truncated": true }, "feedback": { "type": "array", "description": "Investigation feedback associated with this run (only included when details=true)", "items": { "ref": "#/components/schemas/InvestigationFeedback", "type": "object", "required": [ "id", "investigationId", "userId", "organizationId", "createdAt", "updatedAt" ], "truncated": true }, "truncated": true }, "hitl": { "type": "array", "description": "Human-in-the-loop items (approvals and questions) associated with this run (only included when details=true)", "items": { "type": "object", "truncated": true }, "truncated": true } } } }, "total": { "type": "integer", "description": "Total number of runs" }, "limit": { "type": "integer", "description": "Number of items per page" }, "offset": { "type": "integer", "description": "Number of items skipped" } } } } }, "contentTypes": [ "application/json" ], "description": "Paginated list of task flow runs", "statusCode": "200" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/paginated" } }, { "id": "theopolis.taskflows.runs.paginated.get", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/runs/paginated", "stability": "stable", "summary": "Get paginated taskflow runs", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve task flow runs for a specific task flow with pagination", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [ { "deprecated": false, "description": "Include feedback and HITL data for each run", "location": "query", "name": "details", "required": false, "schema": { "type": "boolean" } }, { "deprecated": false, "description": "Number of items per page", "location": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "deprecated": false, "description": "Number of items to skip", "location": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "runs": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowRun", "type": "object", "description": "Represents an execution instance of a task flow", "required": [ "id", "organizationId", "taskFlowId", "status", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "status": { "type": "string", "description": "Current status of the task flow run", "enum": [ "running", "waiting_approval", "paused", "cancelled", "completed", "failed" ], "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true }, "investigationId": { "type": "string", "format": "uuid", "description": "Investigation ID associated with this task flow run", "nullable": true, "truncated": true }, "investigationName": { "type": "string", "description": "Investigation name associated with this task flow run", "nullable": true, "truncated": true }, "feedback": { "type": "array", "description": "Investigation feedback associated with this run (only included when details=true)", "items": { "ref": "#/components/schemas/InvestigationFeedback", "type": "object", "required": [ "id", "investigationId", "userId", "organizationId", "createdAt", "updatedAt" ], "truncated": true }, "truncated": true }, "hitl": { "type": "array", "description": "Human-in-the-loop items (approvals and questions) associated with this run (only included when details=true)", "items": { "type": "object", "truncated": true }, "truncated": true } } } }, "total": { "type": "integer", "description": "Total number of runs" }, "limit": { "type": "integer", "description": "Number of items per page" }, "offset": { "type": "integer", "description": "Number of items skipped" } } } } }, "contentTypes": [ "application/json" ], "description": "Paginated list of task flow runs", "statusCode": "200" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/paginated" } }, { "id": "theopolis.taskflows.runs.pause", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}/pause", "stability": "stable", "summary": "Pause taskflow run", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Programmatically pause a running task flow run for cross-investigation coordination. Sets a Redis signal that the execution loop picks up at the next node boundary. The run transitions to 'paused' status and can be resumed later.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task flow", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task flow run to pause", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pausedByTaskFlowRunId": { "type": "string", "format": "uuid", "description": "ID of the task flow run that triggered the pause (for audit trail)" }, "reason": { "type": "string", "description": "Human-readable reason for the pause" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": false }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Pause signal sent successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request (e.g. run is not in running state)", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}/pause" } }, { "id": "theopolis.taskflows.runs.resume", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/runs/{runId}/resume", "stability": "stable", "summary": "Resume taskflow run", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Resume a task flow run that was paused programmatically (status = 'paused'). Loads saved execution state and continues from the paused node. The run is resumed asynchronously; the API returns immediately.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task flow", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the paused task flow run", "location": "path", "name": "taskFlowRunId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resumedByTaskFlowRunId": { "type": "string", "format": "uuid", "description": "ID of the task flow run that triggered the resume (for audit trail)" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": false }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Resume initiated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request (e.g. run is not in paused state)", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/runs/{taskFlowRunId}/resume" } }, { "id": "theopolis.taskflows.stats.duration.query", "method": "POST", "pathTemplate": "taskflows/stats/duration", "stability": "stable", "summary": "Query taskflow duration stats", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get average investigation run duration for multiple taskflows, grouped by version. Only includes completed runs without human-in-the-loop.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "taskFlowIds" ], "properties": { "taskFlowIds": { "type": "array", "description": "Array of taskflow IDs to get duration stats for", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowDurationStats", "type": "object", "required": [ "taskFlowId", "taskflowVersionNumber", "avgDurationMs", "runCount" ], "properties": { "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "taskflowVersionNumber": { "type": "integer", "truncated": true }, "avgDurationMs": { "type": "number", "description": "Average duration in milliseconds", "truncated": true }, "runCount": { "type": "integer", "description": "Number of completed runs", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Duration statistics grouped by taskflow and version", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/stats/duration" } }, { "id": "theopolis.taskflows.stats.feedback.query", "method": "POST", "pathTemplate": "taskflows/stats/feedback", "stability": "stable", "summary": "Query taskflow feedback stats", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get feedback statistics for multiple taskflows, grouped by version. Includes upvotes, downvotes, neutral votes, and comment counts.", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "taskFlowIds" ], "properties": { "taskFlowIds": { "type": "array", "description": "Array of taskflow IDs to get feedback stats for", "items": { "type": "string", "format": "uuid" } } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowFeedbackStats", "type": "object", "required": [ "taskFlowId", "taskflowVersionNumber", "upvotes", "downvotes", "neutralCount", "commentCount", "totalFeedback", "runCount" ], "properties": { "taskFlowId": { "type": "string", "format": "uuid", "truncated": true }, "taskflowVersionNumber": { "type": "integer", "truncated": true }, "upvotes": { "type": "integer", "description": "Number of positive votes (vote = 1)", "truncated": true }, "downvotes": { "type": "integer", "description": "Number of negative votes (vote = -1)", "truncated": true }, "neutralCount": { "type": "integer", "description": "Number of neutral votes (vote = 0)", "truncated": true }, "commentCount": { "type": "integer", "description": "Number of feedback entries with comments", "truncated": true }, "totalFeedback": { "type": "integer", "description": "Total number of feedback entries", "truncated": true }, "runCount": { "type": "integer", "description": "Number of distinct investigations with feedback", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "Feedback statistics grouped by taskflow and version", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/stats/feedback" } }, { "id": "theopolis.taskflows.trigger", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/trigger", "stability": "stable", "summary": "Trigger taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Trigger a task flow graph execution with signal creation and tracking. Unlike the execute endpoint, this creates a signal and passes it through the Investigation Awareness layer for deduplication before creating an investigation. Returns immediately with a taskFlowRunId and signalId.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "input" ], "properties": { "input": { "type": "string", "description": "The input text to trigger the task flow with" }, "signalId": { "type": "string", "format": "uuid", "description": "Optional existing signal ID. If not provided, a new signal will be created." } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskFlowRunId": { "type": "string", "format": "uuid", "description": "ID of the task flow run that can be used to listen to events" }, "signalId": { "type": "string", "format": "uuid", "description": "ID of the signal associated with this trigger" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow trigger accepted and execution started", "statusCode": "202" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid graph structure or missing input", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/trigger" } }, { "id": "theopolis.taskflows.update", "method": "PUT", "pathTemplate": "taskflows/{taskflowId}", "stability": "stable", "summary": "Update taskflow", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing task flow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowUpdate", "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "oneOf": [ { "ref": "#/components/schemas/StartNode", "description": "Start node - entry point that receives initial input and passes it through. Optionally can create an investigation scope for the entire taskflow execution and set a global prompt for all AI operations.", "truncated": true }, { "ref": "#/components/schemas/TaskNode", "description": "Task node - executes a Theopolis agent with specified persona and goal. A Task entity is created for each execution and automatically linked to the current investigation (if one exists in the taskflow scope). Supports optional human-in-the-loop approval via the allowHumanIntervention flag.", "truncated": true }, { "ref": "#/components/schemas/ChoiceNode", "description": "Choice node - evaluates input using AI and selects which edge to follow based on sourceOutputIndex (choice index 0 maps to edge with sourceOutputIndex: 0, etc.). The original input data is passed through unchanged to the selected downstream node.", "truncated": true }, { "ref": "#/components/schemas/EndNode", "description": "End node - uses AI to generate final workflow output based on prompt and accumulated input", "truncated": true }, { "ref": "#/components/schemas/SetColumnNode", "description": "Set column node - updates the investigation's board column and passes through input data unchanged", "truncated": true } ] } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the edge", "truncated": true }, "source": { "type": "string", "description": "ID of the source node", "truncated": true }, "target": { "type": "string", "description": "ID of the target node", "truncated": true }, "label": { "type": "string", "description": "Optional label for the edge (deprecated, use sourceOutputIndex for choice routing)", "truncated": true }, "sourceOutputIndex": { "type": "integer", "description": "Optional index indicating which output of the source node this edge corresponds to (used for choice node routing)", "truncated": true } } } } } }, "isSignalHandler": { "type": "boolean" }, "tags": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlow", "type": "object", "required": [ "id", "organizationId", "name", "graph", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "truncated": true } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "truncated": true } } } }, "isEnabled": { "type": "boolean" }, "isSignalHandler": { "type": "boolean" }, "tags": { "type": "object" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request - invalid input", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}" } }, { "id": "theopolis.taskflows.versions.create", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/versions", "stability": "stable", "summary": "Create taskflow version", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Creates a snapshot of the current taskflow state as a new version", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowVersionCreateRequest", "type": "object", "properties": { "versionLabel": { "type": "string", "description": "Optional label for this version (e.g., 'Working state', 'Before refactor')" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": false }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "taskFlowId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "truncated": true } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "truncated": true } } } }, "versionLabel": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Version created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/versions" } }, { "id": "theopolis.taskflows.versions.delete", "method": "DELETE", "pathTemplate": "taskflows/{taskflowId}/versions/{version}", "stability": "stable", "summary": "Delete a taskflow version", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Soft deletes a specific version (sets isEnabled to false)", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "Version number", "location": "path", "name": "versionNumber", "required": true, "schema": { "type": "integer" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": "Version deleted successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Version not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/versions/{versionNumber}" } }, { "id": "theopolis.taskflows.versions.get", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/versions/{version}", "stability": "stable", "summary": "Get taskflow version", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieves the complete content of a specific version", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "Version number", "location": "path", "name": "versionNumber", "required": true, "schema": { "type": "integer" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowVersionContent", "type": "object", "required": [ "versionInfo", "graph", "name" ], "properties": { "versionInfo": { "ref": "#/components/schemas/TaskFlowVersionInfo", "type": "object", "required": [ "versionNumber", "name", "createdAt", "createdBy" ], "properties": { "versionNumber": { "type": "integer", "description": "Sequential version number" }, "name": { "type": "string", "description": "Snapshot of taskflow name at version creation" }, "versionLabel": { "type": "string", "description": "Optional user-provided label for the version", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "description": "When this version was created" }, "createdBy": { "type": "string", "format": "uuid", "description": "User who created this version" } } }, "graph": { "ref": "#/components/schemas/TaskFlowGraph", "type": "object", "required": [ "nodes", "edges" ], "properties": { "nodes": { "type": "array", "description": "Array of nodes in the workflow graph", "items": { "ref": "#/components/schemas/TaskFlowNode", "description": "A node in the task flow graph. Use the 'type' field to determine which specific node schema applies.", "truncated": true } }, "edges": { "type": "array", "description": "Array of edges connecting nodes", "items": { "ref": "#/components/schemas/TaskFlowEdge", "type": "object", "required": [ "id", "source", "target" ], "truncated": true } } } }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "Version content", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Version not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/versions/{versionNumber}" } }, { "id": "theopolis.taskflows.versions.list", "method": "GET", "pathTemplate": "taskflows/{taskflowId}/versions", "stability": "stable", "summary": "List taskflow versions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieves all version snapshots for a specific taskflow", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowVersionListResponse", "type": "object", "required": [ "versions" ], "properties": { "versions": { "type": "array", "items": { "ref": "#/components/schemas/TaskFlowVersionInfo", "type": "object", "required": [ "versionNumber", "name", "createdAt", "createdBy" ], "properties": { "versionNumber": { "type": "integer", "description": "Sequential version number", "truncated": true }, "name": { "type": "string", "description": "Snapshot of taskflow name at version creation", "truncated": true }, "versionLabel": { "type": "string", "description": "Optional user-provided label for the version", "nullable": true, "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "description": "When this version was created", "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "description": "User who created this version", "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of versions", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task flow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/versions" } }, { "id": "theopolis.taskflows.versions.restore", "method": "POST", "pathTemplate": "taskflows/{taskflowId}/versions/{version}/restore", "stability": "stable", "summary": "Restore taskflow version", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Restores the taskflow to the state captured in the specified version. Automatically creates a backup version before restoring.", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "Task flow ID", "location": "path", "name": "taskFlowId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "Version number to restore to", "location": "path", "name": "versionNumber", "required": true, "schema": { "type": "integer" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskFlowVersionRestoreResult", "type": "object", "required": [ "success", "taskFlow" ], "properties": { "success": { "type": "boolean" }, "taskFlow": { "type": "object", "required": [ "id", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "backupVersionNumber": { "type": "integer", "description": "Version number of the automatic backup created before restore", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": "Taskflow restored successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Version or taskflow not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/taskflows/{taskFlowId}/versions/{versionNumber}/restore" } }, { "id": "theopolis.tasks.create", "method": "POST", "pathTemplate": "tasks", "stability": "stable", "summary": "Create a persona task", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new task for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskCreate", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "personaId": { "type": "string", "format": "uuid", "nullable": true }, "tags": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Task", "type": "object", "required": [ "id", "name", "goal", "meaningfulness", "guardrails", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "promptVersionId": { "type": "string", "nullable": true }, "goal": { "type": "string" }, "meaningfulness": { "type": "string" }, "guardrails": { "type": "string" }, "personaId": { "type": "string", "format": "uuid", "nullable": true }, "tags": { "type": "object" }, "createdBy": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Task created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks" } }, { "id": "theopolis.tasks.delete", "method": "DELETE", "pathTemplate": "tasks/{taskId}", "stability": "stable", "summary": "Delete task", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete an existing task", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Task deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}" } }, { "id": "theopolis.tasks.get", "method": "GET", "pathTemplate": "tasks/{taskId}", "stability": "stable", "summary": "Get task", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific task by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Task", "type": "object", "required": [ "id", "name", "goal", "meaningfulness", "guardrails", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "promptVersionId": { "type": "string", "nullable": true }, "goal": { "type": "string" }, "meaningfulness": { "type": "string" }, "guardrails": { "type": "string" }, "personaId": { "type": "string", "format": "uuid", "nullable": true }, "tags": { "type": "object" }, "createdBy": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Task details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}" } }, { "id": "theopolis.tasks.list", "method": "GET", "pathTemplate": "tasks", "stability": "stable", "summary": "List tasks", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all tasks for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Task", "type": "object", "required": [ "id", "name", "goal", "meaningfulness", "guardrails", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of tasks", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks" } }, { "id": "theopolis.tasks.paginated.list", "method": "GET", "pathTemplate": "tasks/paginated", "stability": "stable", "summary": "List tasks (paginated)", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve tasks with pagination support", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Page number", "location": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "deprecated": false, "description": "Number of items per page", "location": "query", "name": "pageSize", "required": false, "schema": { "type": "integer" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Task", "type": "object", "required": [ "id", "name", "goal", "meaningfulness", "guardrails", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "truncated": true }, "name": { "type": "string", "truncated": true }, "promptVersionId": { "type": "string", "nullable": true, "truncated": true }, "goal": { "type": "string", "truncated": true }, "meaningfulness": { "type": "string", "truncated": true }, "guardrails": { "type": "string", "truncated": true }, "personaId": { "type": "string", "format": "uuid", "nullable": true, "truncated": true }, "tags": { "type": "object", "truncated": true }, "createdBy": { "type": "string", "format": "uuid", "truncated": true }, "organizationId": { "type": "string", "format": "uuid", "truncated": true }, "createdAt": { "type": "string", "format": "date-time", "truncated": true }, "updatedAt": { "type": "string", "format": "date-time", "truncated": true } } } }, "paging": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "contentTypes": [ "application/json" ], "description": "Paginated list of tasks", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/paginated" } }, { "id": "theopolis.tasks.results.list", "method": "GET", "pathTemplate": "tasks/{taskId}/results", "stability": "stable", "summary": "List task runs and status", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all results for a specific task", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskRun", "type": "object", "required": [ "id", "taskId", "result", "title", "tldr", "status", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of task results", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}/results" } }, { "id": "theopolis.tasks.run.queue", "method": "POST", "pathTemplate": "tasks/{taskId}/run/queue", "stability": "stable", "summary": "Queue task rerun", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Queue a task for execution", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task to execute", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } } } }, "contentTypes": [ "application/json" ], "description": "Task queued successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}/run/queue" } }, { "id": "theopolis.tasks.runs.list", "method": "GET", "pathTemplate": "tasks/{taskId}/runs", "stability": "stable", "summary": "List task runs", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all runs for a specific task", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskRun", "type": "object", "required": [ "id", "taskId", "result", "title", "tldr", "status", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of task runs", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}/runs" } }, { "id": "theopolis.tasks.runs.queue", "method": "POST", "pathTemplate": "tasks/{taskId}/runs/queue", "stability": "stable", "summary": "Queue a task for execution", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Queue a new task run for execution", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskRunQueueRequest", "type": "object", "properties": { "includeRcaAndNextSteps": { "type": "boolean" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": false }, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } } } }, "contentTypes": [ "application/json" ], "description": "Task run queued successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}/runs/queue" } }, { "id": "theopolis.tasks.runs.sections.feedback.create", "method": "POST", "pathTemplate": "tasks/{taskId}/runs/{resultId}/sections/{sectionId}/feedback", "stability": "stable", "summary": "Create section feedback", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create feedback (vote and/or comment) for a specific task result section", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the result", "location": "path", "name": "resultId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the section", "location": "path", "name": "sectionId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskResultSectionFeedbackCreate", "type": "object", "properties": { "vote": { "type": "integer", "nullable": true }, "comment": { "type": "string", "nullable": true } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskResultSectionFeedback", "type": "object", "required": [ "id", "taskResultSectionId", "userId", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "taskResultSectionId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "vote": { "type": "integer", "description": "1 = thumbs up, -1 = thumbs down, null = no vote", "nullable": true }, "comment": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Feedback created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Section not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}/runs/{resultId}/sections/{sectionId}/feedback" } }, { "id": "theopolis.tasks.runs.sections.feedback.update", "method": "PUT", "pathTemplate": "tasks/{taskId}/runs/{resultId}/sections/{sectionId}/feedback/{feedbackId}", "stability": "stable", "summary": "Update section feedback", "target": "theopolis", "openapi": { "matched": false, "openapiOperationId": null, "description": null, "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [], "sourceFile": null, "sourcePath": null } }, { "id": "theopolis.tasks.runs.sections.list", "method": "GET", "pathTemplate": "tasks/{taskId}/runs/{resultId}/sections", "stability": "stable", "summary": "List task run sections", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all sections (RCA, next steps, analysis, etc.) for a specific task run", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the result", "location": "path", "name": "resultId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/TaskResultSection", "type": "object", "required": [ "id", "taskRunId", "sectionType", "title", "content", "organizationId", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of task result sections", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task run not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}/runs/{resultId}/sections" } }, { "id": "theopolis.tasks.update", "method": "PUT", "pathTemplate": "tasks/{taskId}", "stability": "stable", "summary": "Update task", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing task", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the task", "location": "path", "name": "taskId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/TaskUpdate", "type": "object", "properties": { "name": { "type": "string" }, "goal": { "type": "string" }, "meaningfulness": { "type": "string" }, "guardrails": { "type": "string" }, "personaId": { "type": "string", "format": "uuid" }, "tags": { "type": "object" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Task", "type": "object", "required": [ "id", "name", "goal", "meaningfulness", "guardrails", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "promptVersionId": { "type": "string", "nullable": true }, "goal": { "type": "string" }, "meaningfulness": { "type": "string" }, "guardrails": { "type": "string" }, "personaId": { "type": "string", "format": "uuid", "nullable": true }, "tags": { "type": "object" }, "createdBy": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Task updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Task not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/tasks/{taskId}" } }, { "id": "theopolis.threads.artifacts.get", "method": "GET", "pathTemplate": "threads/{threadId}/artifacts", "stability": "stable", "summary": "Get thread artifacts", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all URLs found in a thread's messages, compose operations, and log entries with their source information", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ThreadArtifactsResponse", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of URLs found in the thread", "items": { "ref": "#/components/schemas/ThreadArtifact", "type": "object", "required": [ "url", "source" ], "properties": { "url": { "type": "string", "format": "uri", "description": "A URL found in the thread content", "truncated": true }, "source": { "type": "string", "description": "The source where this URL was found", "enum": [ "user", "assistant", "tool_call", "tool_result", "system", "memory", "reasoning_step", "compose_operation", "log_entry" ], "truncated": true } } } } } } } }, "contentTypes": [ "application/json" ], "description": "List of URLs found in the thread with source information", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}/artifacts" } }, { "id": "theopolis.threads.create", "method": "POST", "pathTemplate": "threads", "stability": "stable", "summary": "Create a chat thread", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new thread for the authenticated user", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ThreadCreate", "type": "object", "required": [ "currentPersonaId" ], "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "currentPersonaId": { "type": "string", "format": "uuid" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Thread", "type": "object", "required": [ "id", "currentPersonaId", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "currentPersonaId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads" } }, { "id": "theopolis.threads.delete", "method": "DELETE", "pathTemplate": "threads/{threadId}", "stability": "stable", "summary": "Delete thread", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete an existing thread", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Thread deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}" } }, { "id": "theopolis.threads.get", "method": "GET", "pathTemplate": "threads/{threadId}", "stability": "stable", "summary": "Get a chat thread", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific thread by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Thread", "type": "object", "required": [ "id", "currentPersonaId", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "currentPersonaId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread details", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}" } }, { "id": "theopolis.threads.instructions.get", "method": "GET", "pathTemplate": "threads/{threadId}/instructions", "stability": "stable", "summary": "Get thread instructions", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Get persona instructions for a specific thread", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [ { "deprecated": false, "description": "The organization ID (defaults to user's organization)", "location": "query", "name": "organizationId", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "deprecated": false, "description": "The persona ID to get instructions for", "location": "query", "name": "personaId", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "type": "object", "required": [ "instructions" ], "properties": { "instructions": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread instructions", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Failed to build persona instructions", "statusCode": "500" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}/instructions" } }, { "id": "theopolis.threads.list", "method": "GET", "pathTemplate": "threads", "stability": "stable", "summary": "List threads", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all threads for the authenticated user with pagination", "parameters": { "cookie": [], "header": [], "path": [], "query": [ { "deprecated": false, "description": "Page number for pagination", "location": "query", "name": "page", "required": false, "schema": { "type": "integer" } }, { "deprecated": false, "description": "Number of items per page", "location": "query", "name": "pageSize", "required": false, "schema": { "type": "integer" } } ] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Thread", "type": "object", "required": [ "id", "currentPersonaId", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of threads with pagination", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads" } }, { "id": "theopolis.threads.logs.get", "method": "GET", "pathTemplate": "threads/{threadId}/logs", "stability": "stable", "summary": "Get thread logs", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all log entries for a specific thread", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of log entries", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}/logs" } }, { "id": "theopolis.threads.messages.create", "method": "POST", "pathTemplate": "threads/{threadId}/messages", "stability": "stable", "summary": "Create thread message", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new message in a specific thread", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/MessageCreate", "type": "object", "required": [ "content", "role" ], "properties": { "content": { "type": "string" }, "role": { "type": "string", "enum": [ "user", "assistant", "system" ] } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Message", "type": "object", "required": [ "id", "threadId", "content", "role", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "threadId": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "role": { "type": "string", "enum": [ "user", "assistant", "system" ] }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Message created successfully", "statusCode": "201" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}/messages" } }, { "id": "theopolis.threads.messages.list", "method": "GET", "pathTemplate": "threads/{threadId}/messages", "stability": "stable", "summary": "List chat thread messages", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all messages for a specific thread", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Message", "type": "object", "required": [ "id", "threadId", "content", "role", "organizationId", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of messages", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}/messages" } }, { "id": "theopolis.threads.update", "method": "PUT", "pathTemplate": "threads/{threadId}", "stability": "stable", "summary": "Update a chat thread", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing thread", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The unique identifier of the thread", "location": "path", "name": "threadId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ThreadUpdate", "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "currentPersonaId": { "type": "string", "format": "uuid" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Thread", "type": "object", "required": [ "id", "currentPersonaId", "organizationId", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "currentPersonaId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Thread not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/threads/{threadId}" } }, { "id": "theopolis.values.create", "method": "POST", "pathTemplate": "values", "stability": "stable", "summary": "Create a value", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Create a new organization value for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ValueCreate", "type": "object", "required": [ "description" ], "properties": { "description": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Value", "type": "object", "required": [ "id", "description", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Value created successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/values" } }, { "id": "theopolis.values.delete", "method": "DELETE", "pathTemplate": "values/{valueId}", "stability": "stable", "summary": "Delete a value", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Delete an organization value", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The value ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": {}, "contentTypes": [], "description": "Value deleted successfully", "statusCode": "204" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Value not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/values/{id}" } }, { "id": "theopolis.values.get", "method": "GET", "pathTemplate": "values/{valueId}", "stability": "stable", "summary": "Get a value", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve a specific organization value by its ID", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The value ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Value", "type": "object", "required": [ "id", "description", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Value found", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Value not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/values/{id}" } }, { "id": "theopolis.values.list", "method": "GET", "pathTemplate": "values", "stability": "stable", "summary": "List values", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Retrieve all organization values for the authenticated user's organization", "parameters": { "cookie": [], "header": [], "path": [], "query": [] }, "requestBody": null, "responses": [ { "content": { "application/json": { "schema": { "allOf": [ { "ref": "#/components/schemas/ResponseItems", "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "truncated": true } }, "paging": { "type": "object", "properties": { "page": { "type": "integer", "truncated": true }, "pageSize": { "type": "integer", "truncated": true }, "totalCount": { "type": "integer", "truncated": true }, "totalPages": { "type": "integer", "truncated": true } } } } }, { "properties": { "items": { "type": "array", "items": { "ref": "#/components/schemas/Value", "type": "object", "required": [ "id", "description", "organizationId", "createdBy", "createdAt", "updatedAt" ], "truncated": true } } } } ] } } }, "contentTypes": [ "application/json" ], "description": "List of values", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/values" } }, { "id": "theopolis.values.update", "method": "PATCH", "pathTemplate": "values/{valueId}", "stability": "stable", "summary": "Update a value", "target": "theopolis", "openapi": { "matched": true, "openapiOperationId": null, "description": "Update an existing organization value", "parameters": { "cookie": [], "header": [], "path": [ { "deprecated": false, "description": "The value ID", "location": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "query": [] }, "requestBody": { "content": { "application/json": { "schema": { "ref": "#/components/schemas/ValueUpdate", "type": "object", "properties": { "description": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": null, "required": true }, "responses": [ { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Value", "type": "object", "required": [ "id", "description", "organizationId", "createdBy", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "contentTypes": [ "application/json" ], "description": "Value updated successfully", "statusCode": "200" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Bad request", "statusCode": "400" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Unauthorized", "statusCode": "401" }, { "content": { "application/json": { "schema": { "ref": "#/components/schemas/Error", "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } } } }, "contentTypes": [ "application/json" ], "description": "Value not found", "statusCode": "404" } ], "sourceFile": "contracts/openapi/theopolis.json", "sourcePath": "/values/{id}" } } ] }