{ "openapi": "3.1.1", "info": { "title": "BuildWithHQ Developer API", "description": "Versioned, app-scoped API. Draft credentials can only read, save, and validate unpublished page JSON. Live credentials are required for publication and live application operations. Tenant identity and physical database routing are derived from the authenticated credential.", "version": "1.0.0-developer-platform" }, "servers": [ { "url": "https://api.buildwithhq.com" } ], "paths": { "/v1/apps/{saasAppId}/mcp": { "post": { "tags": [ "MCP" ], "summary": "Send one MCP Streamable HTTP protocol message.", "description": "Opaque JSON-RPC transport for the curated, permission-filtered BuildWithHQ MCP tool surface. Requires mcp.use plus each invoked tool's ordinary operation scope.", "operationId": "developerMcpInvoke", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperMcpProtocolMessage" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperMcpProtocolMessage" } } } }, "202": { "description": "Accepted" }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/ai/status": { "get": { "tags": [ "DeveloperAi" ], "operationId": "developerAiGetStatus", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AiApiStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AiApiStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AiApiStatus" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/ai/sources/records/{recordId}/ingest": { "post": { "tags": [ "DeveloperAi" ], "operationId": "developerAiIngest", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperAiIngestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperAiIngestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperAiIngestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AiApiIngestReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AiApiIngestReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AiApiIngestReceipt" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/ai/rebuilds": { "post": { "tags": [ "DeveloperAi" ], "operationId": "developerAiQueueRebuild", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperAiRebuildRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperAiRebuildRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperAiRebuildRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AiRebuildReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AiRebuildReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AiRebuildReceipt" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/ai/rebuilds/{jobId}": { "get": { "tags": [ "DeveloperAi" ], "operationId": "developerAiGetRebuild", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AiRebuildStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AiRebuildStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AiRebuildStatus" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/ai/search": { "post": { "tags": [ "DeveloperAi" ], "operationId": "developerAiSearch", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperAiSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperAiSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperAiSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AiApiSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AiApiSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AiApiSearchResult" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/openapi.json": { "get": { "tags": [ "DeveloperAppOpenApi" ], "operationId": "developerAppOpenApiGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The base Developer API plus available installed-service endpoint projections. Pin the returned contract fingerprint and regenerate clients when it changes.", "headers": { "X-BuildWithHQ-Contract-SHA256": { "description": "Lowercase SHA-256 fingerprint for the complete projected contract set.", "required": true, "schema": { "maxLength": 64, "minLength": 64, "pattern": "^[0-9a-f]{64}$", "type": "string" } }, "ETag": { "description": "Quoted strong entity tag containing the same contract SHA-256.", "required": true, "schema": { "pattern": "^\"[0-9a-f]{64}\"$", "type": "string" } }, "Cache-Control": { "description": "The user-specific projection must not be stored by shared or private caches.", "required": true, "schema": { "enum": [ "private, no-store" ], "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/assets": { "get": { "tags": [ "DeveloperAssets" ], "description": "Lists app-level design assets registered for this SaaS application. Requires assets.read.", "operationId": "developerAssetsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetType", "in": "query", "schema": { "enum": [ "document", "font", "image", "stylesheet", "video" ], "type": "string" } }, { "name": "folderPath", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantAssetListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantAssetListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantAssetListResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperAssets" ], "description": "Uploads an app-level design asset (maximum 25 MiB). CSS is parsed under the SaaS stylesheet policy. Requires assets.write.", "operationId": "developerAssetsUpload", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "Asset bytes. Files ending in .dll, .com, or .exe are rejected.", "format": "binary" }, "name": { "maxLength": 300, "type": [ "null", "string" ] }, "description": { "maxLength": 1000, "type": [ "null", "string" ] }, "folderPath": { "maxLength": 500, "type": [ "null", "string" ] }, "assetType": { "enum": [ "document", "font", "image", "stylesheet", "video" ], "type": "string" }, "isPublic": { "type": "boolean", "description": "Private unless explicitly set to true.", "default": false } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantAssetMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantAssetMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantAssetMutationResponse" } } } }, "413": { "description": "Payload Too Large", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/assets/{assetId}/content": { "get": { "tags": [ "DeveloperAssets" ], "description": "Downloads a private or public app-level asset as an attachment. Requires assets.read.", "operationId": "developerAssetsContent", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Disposition": { "description": "Attachment filename selected by the server.", "schema": { "type": "string" } }, "X-Content-Type-Options": { "description": "Always nosniff.", "schema": { "enum": [ "nosniff" ], "type": "string" } }, "Cache-Control": { "description": "Authenticated asset responses are not cached.", "schema": { "enum": [ "private, no-store" ], "type": "string" } } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/assets/{assetId}": { "delete": { "tags": [ "DeveloperAssets" ], "description": "Removes an app-level asset registration and its stored bytes. Requires assets.write.", "operationId": "developerAssetsDelete", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantAssetMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantAssetMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantAssetMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/auth/context": { "get": { "tags": [ "DeveloperAuthContext" ], "operationId": "developerAuthContextGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperAuthContextResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperAuthContextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperAuthContextResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/connector-types": { "get": { "tags": [ "DeveloperConnectorRegistry" ], "operationId": "developerConnectorRegistryList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperConnectorRegistryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperConnectorRegistryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperConnectorRegistryResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/fields": { "get": { "tags": [ "DeveloperCustomFields" ], "operationId": "developerCustomFieldsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageKey", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantCustomFieldList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantCustomFieldList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantCustomFieldList" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperCustomFields" ], "operationId": "developerCustomFieldsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageKey", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperCustomFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperCustomFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperCustomFieldRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomFieldMutation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldMutation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldMutation" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/fields/{fieldDefinitionId}": { "put": { "tags": [ "DeveloperCustomFields" ], "operationId": "developerCustomFieldsUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperCustomFieldRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperCustomFieldRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperCustomFieldRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomFieldMutation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldMutation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldMutation" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/db/contracts": { "get": { "tags": [ "DeveloperDatabaseContracts" ], "operationId": "developerDatabaseContractsGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperDatabaseContractSnapshot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperDatabaseContractSnapshot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperDatabaseContractSnapshot" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/data-connectors": { "get": { "tags": [ "DeveloperDataConnectors" ], "operationId": "developerDataConnectorsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperDataConnectors" ], "operationId": "developerDataConnectorsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperDataConnectorWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperDataConnectorWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperDataConnectorWriteRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/data-connectors/{connectorId}": { "put": { "tags": [ "DeveloperDataConnectors" ], "operationId": "developerDataConnectorsUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperDataConnectorWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperDataConnectorWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperDataConnectorWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "delete": { "tags": [ "DeveloperDataConnectors" ], "operationId": "developerDataConnectorsDeactivate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts": { "post": { "tags": [ "DeveloperHeadlessIdentity" ], "description": "Creates the organization and first owner, or idempotently replays an existing matching signup. Both outcomes return HTTP 201; inspect created (true for creation, false for replay). A conflicting owner subject returns HTTP 409.", "operationId": "developerHeadlessIdentityCreateAccount", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperTenantAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperTenantAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperTenantAccountRequest" } } }, "required": true }, "responses": { "201": { "description": "Organization result. created is true for the first creation and false for a matching idempotent replay.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantAccountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantAccountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantAccountResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "get": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } }, { "name": "afterAppAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationListResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/by-external-id": { "get": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityGetAccount", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "providerKey", "in": "query", "schema": { "type": "string" } }, { "name": "externalAccountId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantAccountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantAccountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantAccountResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/users": { "get": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityListUsers", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserCompleteListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserCompleteListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserCompleteListResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityCreateUser", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperTenantUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperTenantUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperTenantUserRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/users/{userId}": { "patch": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityUpdateUser", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeveloperTenantUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeveloperTenantUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeveloperTenantUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/users/{userId}/deactivate": { "post": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityDeactivateUser", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateDeveloperTenantUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeactivateDeveloperTenantUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeactivateDeveloperTenantUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantUserMutationResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/security-catalog": { "get": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityGetSecurityCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTenantSecurityCatalogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantSecurityCatalogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTenantSecurityCatalogResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/user-token-exchanges": { "post": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityExchangeUserToken", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeDeveloperUserTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExchangeDeveloperUserTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExchangeDeveloperUserTokenRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperDelegatedTokenResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperDelegatedTokenResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperDelegatedTokenResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/delegated-user-tokens/{tokenId}/revoke": { "post": { "tags": [ "DeveloperHeadlessIdentity" ], "operationId": "developerHeadlessIdentityRevokeUserToken", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperTokenRevocationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperTokenRevocationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperTokenRevocationResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbound-endpoints": { "get": { "tags": [ "DeveloperInboundEndpoints" ], "operationId": "developerInboundEndpointsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperInboundEndpoints" ], "operationId": "developerInboundEndpointsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperCreateInboundEndpointRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperCreateInboundEndpointRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperCreateInboundEndpointRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbound-endpoints/{endpointId}/rotate": { "post": { "tags": [ "DeveloperInboundEndpoints" ], "operationId": "developerInboundEndpointsRotate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/services": { "get": { "tags": [ "DeveloperInstalledServices" ], "operationId": "developerInstalledServicesList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceCatalogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceCatalogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceCatalogResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/services/invocations/{invocationId}": { "get": { "tags": [ "DeveloperInstalledServices" ], "operationId": "developerInstalledServicesGetInvocation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invocationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/services/invocations/{invocationId}:cancel": { "post": { "tags": [ "DeveloperInstalledServices" ], "operationId": "developerInstalledServicesCancelInvocation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invocationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskCancelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskCancelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskCancelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskCancellationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskCancellationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceTaskCancellationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/services/{serviceKey}/endpoints/{endpointKey}:invoke": { "post": { "tags": [ "DeveloperInstalledServices" ], "operationId": "developerInstalledServicesInvoke", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "serviceKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "endpointKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceInvokeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceInvokeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperInstalledServiceInvokeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/logs/tail": { "get": { "tags": [ "DeveloperLogs" ], "operationId": "developerLogsTail", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sinceUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/logs/search": { "get": { "tags": [ "DeveloperLogs" ], "operationId": "developerLogsSearch", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "sinceUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/logs/correlations/{logCorrelationId}": { "get": { "tags": [ "DeveloperLogs" ], "operationId": "developerLogsCorrelation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logCorrelationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sinceUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 200 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperLogQueryResult" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/oauth-connections": { "get": { "tags": [ "DeveloperOAuthConnections" ], "operationId": "developerOAuthConnectionsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/oauth-connections/authorizations": { "post": { "tags": [ "DeveloperOAuthConnections" ], "operationId": "developerOAuthConnectionsStartAuthorization", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOAuthAuthorizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOAuthAuthorizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperOAuthAuthorizationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/oauth-connections/authorizations/complete": { "post": { "tags": [ "DeveloperOAuthConnections" ], "operationId": "developerOAuthConnectionsCompleteAuthorization", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOAuthCompletionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOAuthCompletionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperOAuthCompletionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/oauth-connections/{connectionId}/refresh": { "post": { "tags": [ "DeveloperOAuthConnections" ], "operationId": "developerOAuthConnectionsRefresh", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/oauth-connections/{connectionId}": { "delete": { "tags": [ "DeveloperOAuthConnections" ], "operationId": "developerOAuthConnectionsRevoke", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}": { "get": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationAdminResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationAdminResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationAdminResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "patch": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeveloperOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeveloperOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeveloperOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrganizationMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/data-roles": { "put": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleUpsertDataRole", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertDeveloperDataRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertDeveloperDataRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertDeveloperDataRoleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperDataRoleMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperDataRoleMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperDataRoleMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/locations": { "put": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleUpsertLocation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertDeveloperLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertDeveloperLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertDeveloperLocationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperLocationMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperLocationMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperLocationMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/invitations": { "get": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleListInvitations", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationListResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleCreateInvitation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperInvitationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperInvitationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeveloperInvitationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/invitations/{invitationId}/resend": { "post": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleResendInvitation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationRevisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationRevisionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationRevisionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/invitations/{invitationId}/revoke": { "post": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleRevokeInvitation", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationRevisionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationRevisionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationRevisionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperInvitationMutationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/accounts/{appAccountId}/ownership-transfer": { "post": { "tags": [ "DeveloperOrganizationLifecycle" ], "operationId": "developerOrganizationLifecycleTransferOwnership", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferDeveloperOrganizationOwnershipRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransferDeveloperOrganizationOwnershipRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransferDeveloperOrganizationOwnershipRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperOwnershipTransferResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOwnershipTransferResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOwnershipTransferResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/outsideformsubmissions/endpoints": { "get": { "tags": [ "DeveloperOutsideForms" ], "operationId": "developerOutsideFormsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 10000, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpointPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpointPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpointPage" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "DeveloperOutsideForms" ], "operationId": "developerOutsideFormsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpointCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpointCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpointCreateRequest" } } }, "required": true }, "responses": { "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpoint" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpoint" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpoint" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/outsideformsubmissions/browser-challenge": { "get": { "tags": [ "DeveloperOutsideForms" ], "operationId": "developerOutsideFormsBrowserChallenge", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutsideFormBrowserChallengeConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutsideFormBrowserChallengeConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutsideFormBrowserChallengeConfiguration" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/outsideformsubmissions/endpoints/{endpointId}": { "put": { "tags": [ "DeveloperOutsideForms" ], "operationId": "developerOutsideFormsUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOutsideFormEndpointUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperOutsideFormEndpointUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperOutsideFormEndpointUpdateRequest" } } }, "required": true }, "responses": { "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpoint" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpoint" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutsideFormEndpoint" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/outsideformsubmissions/{submissionId}": { "get": { "tags": [ "DeveloperOutsideForms" ], "operationId": "developerOutsideFormsGetSubmission", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutsideFormSubmission" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutsideFormSubmission" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutsideFormSubmission" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/page-drafts": { "get": { "tags": [ "DeveloperPages" ], "operationId": "developerPagesList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageList" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DraftAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/page-drafts/{pageKey}": { "get": { "tags": [ "DeveloperPages" ], "operationId": "developerPagesGetDraft", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraft" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraft" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraft" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DraftAppCredential": [ ] } ] }, "put": { "tags": [ "DeveloperPages" ], "operationId": "developerPagesSaveDraft", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageDraftSave" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DraftAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/page-drafts/{pageKey}/validate": { "post": { "tags": [ "DeveloperPages" ], "operationId": "developerPagesValidate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageValidation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageValidation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageValidation" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DraftAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/page-drafts/{pageKey}/history": { "get": { "tags": [ "DeveloperPages" ], "operationId": "developerPagesHistory", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPageHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPageHistory" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DraftAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/pages/{pageKey}/publish": { "post": { "tags": [ "DeveloperPages" ], "operationId": "developerPagesPublish", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPagePublishRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPagePublishRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperPagePublishRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperPagePublication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPagePublication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPagePublication" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/payment-connectors": { "get": { "tags": [ "DeveloperPaymentConnectors" ], "operationId": "developerPaymentConnectorsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperPaymentConnectors" ], "operationId": "developerPaymentConnectorsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPaymentConnectorWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPaymentConnectorWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperPaymentConnectorWriteRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/payment-connectors/{connectorId}": { "put": { "tags": [ "DeveloperPaymentConnectors" ], "operationId": "developerPaymentConnectorsUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperPaymentConnectorWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperPaymentConnectorWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperPaymentConnectorWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "delete": { "tags": [ "DeveloperPaymentConnectors" ], "operationId": "developerPaymentConnectorsDeactivate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/presentation": { "get": { "tags": [ "DeveloperPresentations" ], "operationId": "developerPresentationsGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkOrdersPresentationDocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPresentationDocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPresentationDocumentResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects": { "get": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsListObjects", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/schema": { "get": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsGetSchema", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/records/search": { "post": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsSearch", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperRecordSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperRecordSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperRecordSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/records/{recordId}": { "get": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "patch": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperUpdateRecordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperUpdateRecordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperUpdateRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsDelete", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectedUpdatedUtc", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/records": { "post": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperCreateRecordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperCreateRecordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperCreateRecordRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/objects/{objectKey}/records/{recordId}/relationships": { "get": { "tags": [ "DeveloperRecords" ], "operationId": "developerRecordsRelationships", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relationKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/runtime/pages/{pageKey}": { "get": { "tags": [ "DeveloperRuntimePages" ], "operationId": "developerRuntimePagesGetBody", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeDesignTokens", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperRuntimePageBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperRuntimePageBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperRuntimePageBody" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/runtime/pages/{pageKey}/bootstrap": { "get": { "tags": [ "DeveloperRuntimePages" ], "operationId": "developerRuntimePagesGetBootstrap", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantRuntimeBootstrap" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeBootstrap" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeBootstrap" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/runtime/bindings": { "post": { "tags": [ "DeveloperRuntimePages" ], "operationId": "developerRuntimePagesResolveBindings", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatch" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/skills": { "get": { "tags": [ "DeveloperSkills" ], "operationId": "developerSkillsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperSkillListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperSkillListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperSkillListResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/skills/{skillVersionId}": { "get": { "tags": [ "DeveloperSkills" ], "operationId": "developerSkillsGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "skillVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperSkillResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperSkillResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperSkillResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw-agents/{goClawAgentId}/skills/{skillKey}": { "put": { "tags": [ "DeveloperSkills" ], "operationId": "developerSkillsAssign", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "goClawAgentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "skillKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperGoClawSkillAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperGoClawSkillAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperGoClawSkillAssignmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperGoClawSkillAssignmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperGoClawSkillAssignmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperGoClawSkillAssignmentResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/theme": { "get": { "tags": [ "DeveloperThemes" ], "description": "Reads the current app-wide mode, CSS variables, and design tokens. Requires themes.read.", "operationId": "developerThemesGet", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperThemeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "put": { "tags": [ "DeveloperThemes" ], "description": "Creates or version-fenced updates the app-wide theme used by the hosted runtime and portable bootstrap. Requires themes.write.", "operationId": "developerThemesPut", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeveloperThemeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperThemeResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/webhook-deliveries": { "get": { "tags": [ "DeveloperWebhookDeliveries" ], "operationId": "developerWebhookDeliveriesList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/webhook-deliveries/{deliveryId}/retry": { "post": { "tags": [ "DeveloperWebhookDeliveries" ], "operationId": "developerWebhookDeliveriesRetry", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/webhook-event-types": { "get": { "tags": [ "DeveloperWebhookSubscriptions" ], "operationId": "developerWebhookSubscriptionsListEventTypes", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/webhooks": { "get": { "tags": [ "DeveloperWebhookSubscriptions" ], "operationId": "developerWebhookSubscriptionsList", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] }, "post": { "tags": [ "DeveloperWebhookSubscriptions" ], "operationId": "developerWebhookSubscriptionsCreate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookSubscriptionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/webhooks/{subscriptionId}": { "put": { "tags": [ "DeveloperWebhookSubscriptions" ], "operationId": "developerWebhookSubscriptionsUpdate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeveloperWebhookSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/webhooks/{subscriptionId}/rotate-secret": { "post": { "tags": [ "DeveloperWebhookSubscriptions" ], "operationId": "developerWebhookSubscriptionsRotate", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "The request conflicts with current data. Refresh the affected state before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "422": { "description": "The request cannot be processed under the current rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] } ] } }, "/v1": { "get": { "tags": [ "GatewayMetadata" ], "operationId": "gatewayMetadataGetMetadata", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GatewayMetadataResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GatewayMetadataResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GatewayMetadataResponse" } } } } }, "security": [ ] } }, "/": { "get": { "tags": [ "GatewayMetadata" ], "operationId": "gatewayMetadataGetRoot", "responses": { "302": { "description": "Found" } }, "security": [ ] } }, "/health": { "get": { "tags": [ "GatewayMetadata" ], "operationId": "gatewayMetadataGetHealth", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GatewayMetadataResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GatewayMetadataResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GatewayMetadataResponse" } } } } }, "security": [ ] } }, "/v1/platform/openapi": { "get": { "tags": [ "PlatformOwnerOpenApi" ], "operationId": "platformOwnerOpenApiGetDocument", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } } } }, "security": [ ] } }, "/v1/apps/{saasAppId}/modules/active-workplace": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplace", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "ownerUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "participantId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activeWorkplaceId": { "type": "string", "format": "uuid" }, "rootRecordId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "ownerUserId": { "type": "string", "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "rootTitle": { "type": [ "null", "string" ] }, "rootModuleKey": { "type": [ "null", "string" ] }, "rootModuleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "lastMeaningfulActivityUtc": { "type": "string", "format": "date-time" }, "atRiskUtc": { "type": "string", "format": "date-time" }, "staleUtc": { "type": "string", "format": "date-time" }, "waitingUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "waitingReason": { "type": [ "null", "string" ] }, "resolvedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "participantCount": { "type": "integer", "format": "int32" }, "goClawCount": { "type": "integer", "format": "int32" }, "pendingInboxCount": { "type": "integer", "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerPostV1AppsModulesActiveWorkplace", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/lego/catalog": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplaceLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/lego/lookups/{lookupId}": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplaceLegoLookupsLookupIdGuid", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/lego/presentation": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplaceLegoPresentation", "parameters": [ { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activeWorkplaceId": { "type": "string", "format": "uuid" }, "rootRecordId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "ownerUserId": { "type": "string", "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "rootTitle": { "type": [ "null", "string" ] }, "rootModuleKey": { "type": [ "null", "string" ] }, "rootModuleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "lastMeaningfulActivityUtc": { "type": "string", "format": "date-time" }, "atRiskUtc": { "type": "string", "format": "date-time" }, "staleUtc": { "type": "string", "format": "date-time" }, "waitingUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "waitingReason": { "type": [ "null", "string" ] }, "resolvedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "participantCount": { "type": "integer", "format": "int32" }, "goClawCount": { "type": "integer", "format": "int32" }, "pendingInboxCount": { "type": "integer", "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuid", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "rootRecordId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "ownerUserId": { "type": "string", "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "graphScope": { }, "staleAfterMinutes": { "type": "integer", "format": "int32" }, "warningBeforeStaleMinutes": { "type": "integer", "format": "int32" }, "lastMeaningfulActivityUtc": { "type": "string", "format": "date-time" }, "atRiskUtc": { "type": "string", "format": "date-time" }, "staleUtc": { "type": "string", "format": "date-time" }, "waitingUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "waitingReason": { "type": [ "null", "string" ] }, "resolvedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "rootRecord": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "depth": { "type": [ "null", "integer" ], "format": "int32" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": [ "null", "boolean" ] } } }, "graph": { "type": "object", "properties": { "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "storedNodeCount": { "type": [ "null", "integer" ], "format": "int32" }, "nodes": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "depth": { "type": [ "null", "integer" ], "format": "int32" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": [ "null", "boolean" ] } } } }, "edges": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordRelationId": { "type": "string", "format": "uuid" }, "fromRecordId": { "type": "string", "format": "uuid" }, "toRecordId": { "type": "string", "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" }, "relationKey": { "type": [ "null", "string" ] } } } } } }, "participants": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activeWorkplaceParticipantId": { "type": "string", "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "effectiveUserId": { "type": [ "null", "string" ], "format": "uuid" }, "roleName": { "type": [ "null", "string" ] }, "responsibilityText": { "type": [ "null", "string" ] }, "isOwner": { "type": "boolean" }, "isWatcher": { "type": "boolean" }, "canAct": { "type": "boolean" }, "eventSubscriptions": { }, "allowedActions": { }, "approvalPolicy": { }, "escalationPolicy": { }, "joinedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } }, "activity": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activeWorkplaceEventId": { "type": "integer", "format": "int64" }, "eventAtUtc": { "type": "string", "format": "date-time" }, "actorType": { "type": [ "null", "string" ] }, "actorId": { "type": [ "null", "string" ], "format": "uuid" }, "actorDisplayName": { "type": [ "null", "string" ] }, "eventType": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "summary": { "type": [ "null", "string" ] }, "eventData": { }, "isMeaningfulActivity": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } }, "pendingInboxCount": { "type": "integer", "format": "int32" }, "playbackStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "playbackEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "patch": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerPatchV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuid", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/status": { "post": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerPostV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidStatus", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/participants/catalog": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidParticipantsCatalog", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "users": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "participantId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "effectiveUserId": { "type": [ "null", "string" ], "format": "uuid" }, "authorityLevel": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "integer" ], "format": "int32" } } } }, "goClaws": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "participantId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "effectiveUserId": { "type": [ "null", "string" ], "format": "uuid" }, "authorityLevel": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "integer" ], "format": "int32" } } } }, "workflows": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "participantId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "effectiveUserId": { "type": [ "null", "string" ], "format": "uuid" }, "authorityLevel": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "integer" ], "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/participants": { "post": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerPostV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidParticipants", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceParticipantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceParticipantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceParticipantRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/participants/{activeWorkplaceParticipantId}": { "delete": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerDeleteV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidParticipantsActiveWorkplaceParticipantIdGuid", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "activeWorkplaceParticipantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/activity": { "post": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerPostV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidActivity", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceActivityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceActivityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActiveWorkplaceActivityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/graph/refresh": { "post": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerPostV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidGraphRefresh", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "activeWorkplaceParticipantId": { "type": [ "null", "string" ], "format": "uuid" }, "activeWorkplaceEventId": { "type": [ "null", "integer" ], "format": "int64" }, "activeWorkplaceSnapshotId": { "type": [ "null", "string" ], "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "eventAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/active-workplace/{activeWorkplaceId}/playback": { "get": { "tags": [ "TenantActiveWorkplace" ], "operationId": "developerGetV1AppsModulesActiveWorkplaceActiveWorkplaceIdGuidPlayback", "parameters": [ { "name": "activeWorkplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "at", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "activeWorkplaceId": { "type": "string", "format": "uuid" }, "asOfUtc": { "type": "string", "format": "date-time" }, "snapshotAtUtc": { "type": "string", "format": "date-time" }, "readOnly": { "type": "boolean" }, "displayName": { "type": [ "null", "string" ] }, "ownerUserId": { "type": "string", "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "graphScope": { }, "lastMeaningfulActivityUtc": { "type": "string", "format": "date-time" }, "waitingUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "waitingReason": { "type": [ "null", "string" ] }, "resolvedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "graph": { "type": "object", "properties": { "snapshotAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "storedNodeCount": { "type": [ "null", "integer" ], "format": "int32" }, "nodes": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "depth": { "type": [ "null", "integer" ], "format": "int32" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": [ "null", "boolean" ] } } } }, "edges": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordRelationId": { "type": "string", "format": "uuid" }, "fromRecordId": { "type": "string", "format": "uuid" }, "toRecordId": { "type": "string", "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" }, "relationKey": { "type": [ "null", "string" ] } } } } } }, "participants": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activeWorkplaceParticipantId": { "type": "string", "format": "uuid" }, "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "effectiveUserId": { "type": [ "null", "string" ], "format": "uuid" }, "roleName": { "type": [ "null", "string" ] }, "responsibilityText": { "type": [ "null", "string" ] }, "isOwner": { "type": "boolean" }, "isWatcher": { "type": "boolean" }, "canAct": { "type": "boolean" }, "eventSubscriptions": { }, "allowedActions": { }, "approvalPolicy": { }, "escalationPolicy": { }, "joinedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } }, "activity": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activeWorkplaceEventId": { "type": "integer", "format": "int64" }, "eventAtUtc": { "type": "string", "format": "date-time" }, "actorType": { "type": [ "null", "string" ] }, "actorId": { "type": [ "null", "string" ], "format": "uuid" }, "actorDisplayName": { "type": [ "null", "string" ] }, "eventType": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "summary": { "type": [ "null", "string" ] }, "eventData": { }, "isMeaningfulActivity": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/ai-insights": { "get": { "tags": [ "TenantAiInsights" ], "operationId": "developerGetV1AppsModulesAiInsights", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "schema": { "type": "string" } }, { "name": "insightType", "in": "query", "schema": { "type": "string" } }, { "name": "unviewedOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "hiddenOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "includeSnoozed", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "unviewedCount": { "type": "integer", "format": "int32" }, "pinnedCount": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "insightId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": "string", "format": "uuid" }, "sourceModuleKey": { "type": [ "null", "string" ] }, "insightType": { "type": [ "null", "string" ] }, "insightCategory": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "recommendedAction": { "type": [ "null", "string" ] }, "priorityScore": { "type": "integer", "format": "int32" }, "confidenceScore": { "type": [ "null", "number" ], "format": "double" }, "severity": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "sourceRecordTitle": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "hasViewed": { "type": "boolean" }, "isPinned": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "generatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/ai-insights/{insightId}": { "get": { "tags": [ "TenantAiInsights" ], "operationId": "developerGetV1AppsModulesAiInsightsInsightIdGuid", "parameters": [ { "name": "insightId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "evidenceCount": { "type": "integer", "format": "int32" }, "evidence": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "evidenceId": { "type": [ "null", "string" ] }, "evidenceType": { "type": [ "null", "string" ] }, "sourceModuleKey": { "type": [ "null", "string" ] }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "pageNumber": { "type": [ "null", "integer" ], "format": "int32" }, "title": { "type": [ "null", "string" ] }, "snippet": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } } }, "insightId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": "string", "format": "uuid" }, "sourceModuleKey": { "type": [ "null", "string" ] }, "insightType": { "type": [ "null", "string" ] }, "insightCategory": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "recommendedAction": { "type": [ "null", "string" ] }, "priorityScore": { "type": "integer", "format": "int32" }, "confidenceScore": { "type": [ "null", "number" ], "format": "double" }, "severity": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "sourceRecordTitle": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "hasViewed": { "type": "boolean" }, "isPinned": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "generatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/ai-insights/{insightId}/state": { "put": { "tags": [ "TenantAiInsights" ], "operationId": "developerPutV1AppsModulesAiInsightsInsightIdGuidState", "parameters": [ { "name": "insightId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiInsightStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AiInsightStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AiInsightStateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "insightId": { "type": "string", "format": "uuid" }, "hasViewed": { "type": "boolean" }, "isPinned": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/calendar": { "get": { "tags": [ "TenantCalendar" ], "operationId": "developerGetV1AppsModulesCalendar", "parameters": [ { "name": "windowStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "windowEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ownerUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "windowStart": { "type": "string", "format": "date-time" }, "windowEnd": { "type": "string", "format": "date-time" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "eventId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "isAllDay": { "type": "boolean" }, "locationText": { "type": [ "null", "string" ] }, "colorKey": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "recurrenceRule": { "type": [ "null", "string" ] }, "recurrenceEnd": { "type": [ "null", "string" ], "format": "date-time" }, "isPrivate": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantCalendar" ], "operationId": "developerPostV1AppsModulesCalendar", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "eventId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/calendar/{recordId}": { "get": { "tags": [ "TenantCalendar" ], "operationId": "developerGetV1AppsModulesCalendarRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "locationLat": { "type": [ "null", "number" ], "format": "double" }, "locationLng": { "type": [ "null", "number" ], "format": "double" }, "reminderMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "videoConferenceUrl": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "relationCount": { "type": "integer", "format": "int32" }, "attendeeCount": { "type": "integer", "format": "int32" }, "resourceBookingCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "attendees": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "eventAttendeeId": { "type": "string", "format": "uuid" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "externalEmail": { "type": [ "null", "string" ] }, "responseStatus": { "type": [ "null", "string" ] }, "isOrganizer": { "type": "boolean" }, "isOptional": { "type": "boolean" } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "eventId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "isAllDay": { "type": "boolean" }, "locationText": { "type": [ "null", "string" ] }, "colorKey": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "recurrenceRule": { "type": [ "null", "string" ] }, "recurrenceEnd": { "type": [ "null", "string" ], "format": "date-time" }, "isPrivate": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantCalendar" ], "operationId": "developerPutV1AppsModulesCalendarRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "eventId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantCalendar" ], "operationId": "developerDeleteV1AppsModulesCalendarRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/calendar/capabilities": { "get": { "tags": [ "TenantCalendar" ], "operationId": "developerGetV1AppsModulesCalendarCapabilities", "parameters": [ { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/calendar/{recordId}/favorite": { "put": { "tags": [ "TenantCalendar" ], "operationId": "developerPutV1AppsModulesCalendarRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CalendarFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CalendarFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "eventId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/calendar/lego/catalog": { "get": { "tags": [ "TenantCalendar" ], "operationId": "developerGetV1AppsModulesCalendarLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms": { "get": { "tags": [ "TenantChatRooms" ], "operationId": "developerGetV1AppsModulesChatRooms", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canCreate": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "chatRoomId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "roomName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "roomType": { "type": "integer", "format": "uint8" }, "isArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isAdmin": { "type": "boolean" }, "isMuted": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "memberCount": { "type": "integer", "format": "int32" }, "unreadCount": { "type": "integer", "format": "int32" }, "lastMessageText": { "type": [ "null", "string" ] }, "lastMessageUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessageByDisplayName": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantChatRooms" ], "operationId": "developerPostV1AppsModulesChatRooms", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatRoomWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatRoomWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}": { "get": { "tags": [ "TenantChatRooms" ], "operationId": "developerGetV1AppsModulesChatRoomsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "status": { "type": [ "null", "string" ] }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canPost": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "members": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "isAdmin": { "type": "boolean" }, "isMuted": { "type": "boolean" }, "joinedUtc": { "type": "string", "format": "date-time" }, "isCurrentUser": { "type": "boolean" } } } }, "messages": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "chatMessageId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "messageText": { "type": [ "null", "string" ] }, "postedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "postedByDisplayName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "parentChatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "attachedFileId": { "type": [ "null", "string" ], "format": "uuid" }, "isPinned": { "type": "boolean" }, "editedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "reactions": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "reaction": { "type": [ "null", "string" ] }, "reactionCount": { "type": "integer", "format": "int32" }, "reactedByCurrentUser": { "type": "boolean" } } } } } } }, "chatRoomId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "roomName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "roomType": { "type": "integer", "format": "uint8" }, "isArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isAdmin": { "type": "boolean" }, "isMuted": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "memberCount": { "type": "integer", "format": "int32" }, "unreadCount": { "type": "integer", "format": "int32" }, "lastMessageText": { "type": [ "null", "string" ] }, "lastMessageUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessageByDisplayName": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantChatRooms" ], "operationId": "developerPutV1AppsModulesChatRoomsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatRoomWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatRoomWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantChatRooms" ], "operationId": "developerDeleteV1AppsModulesChatRoomsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/lego/catalog": { "get": { "tags": [ "TenantChatRooms" ], "operationId": "developerGetV1AppsModulesChatRoomsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/messages": { "post": { "tags": [ "TenantChatRooms" ], "operationId": "developerPostV1AppsModulesChatRoomsRecordIdGuidMessages", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatMessageWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatMessageWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/messages/{chatMessageId}": { "put": { "tags": [ "TenantChatRooms" ], "operationId": "developerPutV1AppsModulesChatRoomsRecordIdGuidMessagesChatMessageIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatMessageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatMessageUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatMessageUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantChatRooms" ], "operationId": "developerDeleteV1AppsModulesChatRoomsRecordIdGuidMessagesChatMessageIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatMessageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectedUpdatedUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/messages/{chatMessageId}/reaction": { "put": { "tags": [ "TenantChatRooms" ], "operationId": "developerPutV1AppsModulesChatRoomsRecordIdGuidMessagesChatMessageIdGuidReaction", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatMessageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatReactionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatReactionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatReactionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/members/{memberUserId}": { "put": { "tags": [ "TenantChatRooms" ], "operationId": "developerPutV1AppsModulesChatRoomsRecordIdGuidMembersMemberUserIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberUserId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomMemberWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatRoomMemberWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatRoomMemberWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/members/lookup": { "get": { "tags": [ "TenantChatRooms" ], "operationId": "developerGetV1AppsModulesChatRoomsRecordIdGuidMembersLookup", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "users": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/read": { "put": { "tags": [ "TenantChatRooms" ], "operationId": "developerPutV1AppsModulesChatRoomsRecordIdGuidRead", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/chat-rooms/{recordId}/favorite": { "put": { "tags": [ "TenantChatRooms" ], "operationId": "developerPutV1AppsModulesChatRoomsRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatRoomFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatRoomFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "chatRoomId": { "type": [ "null", "string" ], "format": "uuid" }, "chatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "messageRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "memberUserId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReadMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isMember": { "type": [ "null", "boolean" ] }, "isAdmin": { "type": [ "null", "boolean" ] }, "isMuted": { "type": [ "null", "boolean" ] }, "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "boolean" ] }, "reactionCount": { "type": [ "null", "integer" ], "format": "int32" }, "unreadCount": { "type": [ "null", "integer" ], "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/lego/catalog": { "get": { "tags": [ "TenantChecklists" ], "operationId": "developerGetV1AppsModulesChecklistsSignoffsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/lookups/{lookupId}": { "get": { "tags": [ "TenantChecklists" ], "operationId": "developerGetV1AppsModulesChecklistsSignoffsLookupsLookupIdGuid", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/templates": { "get": { "tags": [ "TenantChecklists" ], "operationId": "developerGetV1AppsModulesChecklistsSignoffsTemplates", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "checklistTemplateId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "approvalWorkflowDefinitionId": { "type": "string", "format": "uuid" }, "itemCount": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantChecklists" ], "operationId": "developerPostV1AppsModulesChecklistsSignoffsTemplates", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistTemplateCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChecklistTemplateCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChecklistTemplateCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/templates/{checklistTemplateId}": { "get": { "tags": [ "TenantChecklists" ], "operationId": "developerGetV1AppsModulesChecklistsSignoffsTemplatesChecklistTemplateIdGuid", "parameters": [ { "name": "checklistTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "checklistTemplateItemId": { "type": "string", "format": "uuid" }, "itemKey": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "instructions": { "type": [ "null", "string" ] }, "responseType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "evidenceRequirement": { "type": [ "null", "string" ] }, "minimumEvidenceCount": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" } } } }, "checklistTemplateId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "approvalWorkflowDefinitionId": { "type": "string", "format": "uuid" }, "itemCount": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantChecklists" ], "operationId": "developerPutV1AppsModulesChecklistsSignoffsTemplatesChecklistTemplateIdGuid", "parameters": [ { "name": "checklistTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistTemplateUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChecklistTemplateUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChecklistTemplateUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantChecklists" ], "operationId": "developerDeleteV1AppsModulesChecklistsSignoffsTemplatesChecklistTemplateIdGuid", "parameters": [ { "name": "checklistTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "checklistTemplateId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/runs": { "get": { "tags": [ "TenantChecklists" ], "operationId": "developerGetV1AppsModulesChecklistsSignoffsRuns", "parameters": [ { "name": "targetRecordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "checklistRunId": { "type": "string", "format": "uuid" }, "targetRecordId": { "type": "string", "format": "uuid" }, "targetTitle": { "type": [ "null", "string" ] }, "targetModuleId": { "type": [ "null", "string" ], "format": "uuid" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "checklistTemplateId": { "type": "string", "format": "uuid" }, "templateName": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": "integer", "format": "int64" }, "itemCount": { "type": "integer", "format": "int32" }, "completedItemCount": { "type": "integer", "format": "int32" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantChecklists" ], "operationId": "developerPostV1AppsModulesChecklistsSignoffsRuns", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistRunStartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChecklistRunStartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChecklistRunStartRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/runs/{checklistRunId}": { "get": { "tags": [ "TenantChecklists" ], "operationId": "developerGetV1AppsModulesChecklistsSignoffsRunsChecklistRunIdGuid", "parameters": [ { "name": "checklistRunId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canEdit": { "type": "boolean" }, "submittedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "signedOffByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "signedOffByName": { "type": [ "null", "string" ] }, "signedOffUtc": { "type": [ "null", "string" ], "format": "date-time" }, "rejectedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "rejectedByName": { "type": [ "null", "string" ] }, "rejectedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "rejectionReason": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "checklistRunItemId": { "type": "string", "format": "uuid" }, "itemKey": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "instructions": { "type": [ "null", "string" ] }, "responseType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "evidenceRequirement": { "type": [ "null", "string" ] }, "minimumEvidenceCount": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "status": { "type": [ "null", "string" ] }, "responseText": { "type": [ "null", "string" ] }, "completedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "completedByName": { "type": [ "null", "string" ] }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "revision": { "type": "integer", "format": "int64" }, "evidence": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "checklistItemEvidenceId": { "type": "string", "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "caption": { "type": [ "null", "string" ] }, "fileRecordId": { "type": "string", "format": "uuid" }, "fileName": { "type": [ "null", "string" ] }, "contentType": { "type": [ "null", "string" ] }, "sizeBytes": { "type": [ "null", "integer" ], "format": "int64" }, "addedByUserId": { "type": "string", "format": "uuid" }, "addedByName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } } } } } }, "checklistRunId": { "type": "string", "format": "uuid" }, "targetRecordId": { "type": "string", "format": "uuid" }, "targetTitle": { "type": [ "null", "string" ] }, "targetModuleId": { "type": [ "null", "string" ], "format": "uuid" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "checklistTemplateId": { "type": "string", "format": "uuid" }, "templateName": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": "integer", "format": "int64" }, "itemCount": { "type": "integer", "format": "int32" }, "completedItemCount": { "type": "integer", "format": "int32" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/items/{checklistRunItemId}": { "put": { "tags": [ "TenantChecklists" ], "operationId": "developerPutV1AppsModulesChecklistsSignoffsItemsChecklistRunItemIdGuid", "parameters": [ { "name": "checklistRunItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistItemUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChecklistItemUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChecklistItemUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/items/{checklistRunItemId}/proof": { "post": { "tags": [ "TenantChecklists" ], "operationId": "developerPostV1AppsModulesChecklistsSignoffsItemsChecklistRunItemIdGuidProof", "parameters": [ { "name": "checklistRunItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistProofAttachRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChecklistProofAttachRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChecklistProofAttachRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/proof/{checklistItemEvidenceId}": { "delete": { "tags": [ "TenantChecklists" ], "operationId": "developerDeleteV1AppsModulesChecklistsSignoffsProofChecklistItemEvidenceIdGuid", "parameters": [ { "name": "checklistItemEvidenceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/checklists-signoffs/runs/{checklistRunId}/submit": { "post": { "tags": [ "TenantChecklists" ], "operationId": "developerPostV1AppsModulesChecklistsSignoffsRunsChecklistRunIdGuidSubmit", "parameters": [ { "name": "checklistRunId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChecklistSubmitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChecklistSubmitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChecklistSubmitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/company-news/schema": { "get": { "tags": [ "TenantCompanyNews" ], "operationId": "developerGetV1AppsModulesCompanyNewsSchema", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "catalogId": { "type": "string", "format": "uuid" }, "catalogVersion": { "type": "integer", "format": "int32" }, "resources": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "resourceId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "fieldCatalogId": { "type": "string", "format": "uuid" }, "bindingIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } } }, "fieldCatalogs": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldCatalogId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "required": { "type": "boolean" }, "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "maximumLength": { "type": [ "null", "integer" ], "format": "int32" }, "minimum": { "type": [ "null", "number" ], "format": "double" }, "maximum": { "type": [ "null", "number" ], "format": "double" }, "choiceIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "lookupId": { "type": [ "null", "string" ], "format": "uuid" } } } } } } }, "bindings": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "bindingId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "presentationKind": { "type": [ "null", "string" ] }, "defaultPageSize": { "type": "integer", "format": "int32" }, "maximumPageSize": { "type": "integer", "format": "int32" }, "filterFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "sortFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } } }, "actions": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "kind": { "type": [ "null", "string" ] }, "inputFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "requiresRecordId": { "type": "boolean" }, "requiresExpectedRevision": { "type": "boolean" }, "requiresConfirmation": { "type": "boolean" }, "result": { "type": "object", "properties": { "returnsRevision": { "type": "boolean" }, "canConflict": { "type": "boolean" }, "refreshBindingId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "components": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "componentId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "rendererKey": { "type": [ "null", "string" ] }, "trustLevel": { "type": [ "null", "string" ] }, "resourceId": { "type": [ "null", "string" ], "format": "uuid" }, "bindingId": { "type": [ "null", "string" ], "format": "uuid" }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "fieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "defaultProps": { } } } }, "vocabularies": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "vocabularyId": { "type": "string", "format": "uuid" }, "fieldId": { "type": "string", "format": "uuid" }, "allowsCustomValue": { "type": "boolean" }, "choices": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "choiceId": { "type": "string", "format": "uuid" }, "value": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] } } } } } } }, "lookups": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "lookupId": { "type": "string", "format": "uuid" }, "kind": { "type": [ "null", "string" ] }, "maximumPageSize": { "type": "integer", "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/company-news/lookups/{lookupId}": { "get": { "tags": [ "TenantCompanyNews" ], "operationId": "developerGetV1AppsModulesCompanyNewsLookupsLookupIdGuid", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "lookupId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "optionId": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/company-news": { "get": { "tags": [ "TenantCompanyNews" ], "operationId": "developerGetV1AppsModulesCompanyNews", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeDrafts", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canEdit": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "companyNewsId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "body": { "type": [ "null", "string" ] }, "publishUtc": { "type": [ "null", "string" ], "format": "date-time" }, "expiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isPublished": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantCompanyNews" ], "operationId": "developerPostV1AppsModulesCompanyNews", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyNewsWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "companyNewsId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isPublished": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/company-news/{recordId}": { "get": { "tags": [ "TenantCompanyNews" ], "operationId": "developerGetV1AppsModulesCompanyNewsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "companyNewsId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "body": { "type": [ "null", "string" ] }, "publishUtc": { "type": [ "null", "string" ], "format": "date-time" }, "expiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isPublished": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantCompanyNews" ], "operationId": "developerPutV1AppsModulesCompanyNewsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyNewsWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "companyNewsId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isPublished": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantCompanyNews" ], "operationId": "developerDeleteV1AppsModulesCompanyNewsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/company-news/{recordId}/favorite": { "put": { "tags": [ "TenantCompanyNews" ], "operationId": "developerPutV1AppsModulesCompanyNewsRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyNewsFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "companyNewsId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isPublished": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/company-news/{recordId}/published": { "put": { "tags": [ "TenantCompanyNews" ], "operationId": "developerPutV1AppsModulesCompanyNewsRecordIdGuidPublished", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsPublishedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyNewsPublishedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyNewsPublishedRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "companyNewsId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "isPublished": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts/schema": { "get": { "tags": [ "TenantContacts" ], "operationId": "developerGetV1AppsModulesContactsSchema", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "catalogId": { "type": "string", "format": "uuid" }, "catalogVersion": { "type": "integer", "format": "int32" }, "resources": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "resourceId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "fieldCatalogId": { "type": "string", "format": "uuid" }, "bindingIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } } }, "fieldCatalogs": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldCatalogId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "required": { "type": "boolean" }, "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "maximumLength": { "type": [ "null", "integer" ], "format": "int32" }, "minimum": { "type": [ "null", "number" ], "format": "double" }, "maximum": { "type": [ "null", "number" ], "format": "double" }, "choiceIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "lookupId": { "type": [ "null", "string" ], "format": "uuid" } } } } } } }, "bindings": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "bindingId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "presentationKind": { "type": [ "null", "string" ] }, "defaultPageSize": { "type": "integer", "format": "int32" }, "maximumPageSize": { "type": "integer", "format": "int32" }, "filterFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "sortFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } } }, "actions": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "kind": { "type": [ "null", "string" ] }, "inputFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "requiresRecordId": { "type": "boolean" }, "requiresExpectedRevision": { "type": "boolean" }, "requiresConfirmation": { "type": "boolean" }, "result": { "type": "object", "properties": { "returnsRevision": { "type": "boolean" }, "canConflict": { "type": "boolean" }, "refreshBindingId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "components": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "componentId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "rendererKey": { "type": [ "null", "string" ] }, "trustLevel": { "type": [ "null", "string" ] }, "resourceId": { "type": [ "null", "string" ], "format": "uuid" }, "bindingId": { "type": [ "null", "string" ], "format": "uuid" }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "fieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "defaultProps": { } } } }, "vocabularies": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "vocabularyId": { "type": "string", "format": "uuid" }, "fieldId": { "type": "string", "format": "uuid" }, "allowsCustomValue": { "type": "boolean" }, "choices": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "choiceId": { "type": "string", "format": "uuid" }, "value": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] } } } } } } }, "lookups": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "lookupId": { "type": "string", "format": "uuid" }, "kind": { "type": [ "null", "string" ] }, "maximumPageSize": { "type": "integer", "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts/lookups/{lookupId}": { "get": { "tags": [ "TenantContacts" ], "operationId": "developerGetV1AppsModulesContactsLookupsLookupIdGuid", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "lookupId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "optionId": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts/create-visibility-options": { "get": { "tags": [ "TenantContacts" ], "operationId": "developerGetV1AppsModulesContactsCreateVisibilityOptions", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "options": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "scope": { "type": [ "null", "string" ] }, "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts": { "get": { "tags": [ "TenantContacts" ], "description": "Returns fast authorized rows within the 5,000-record browse window. Non-exact totalRecords is not a full count. Fetch the exact total separately with GET /v1/apps/{saasAppId}/modules/contacts/count using the same filters and identity. Legacy includeTotal=true requests return HTTP 400 with code contacts_count_endpoint_required. Omitted or false is accepted. Keep rows usable if the separate count request fails; never report a failed count as zero.", "operationId": "developerGetV1AppsModulesContacts", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "contactType", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "contactTypeId", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "browseLimit": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "contactType": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ], "format": "email" }, "phone": { "type": [ "null", "string" ] }, "mobilePhone": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantContacts" ], "operationId": "developerPostV1AppsModulesContacts", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts/count": { "get": { "tags": [ "TenantContacts" ], "operationId": "developerGetV1AppsModulesContactsCount", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "contactType", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "contactTypeId", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalIsExact": { "type": "boolean" }, "browseLimit": { "type": "integer", "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts/{recordId}": { "get": { "tags": [ "TenantContacts" ], "operationId": "developerGetV1AppsModulesContactsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "address1": { "type": [ "null", "string" ] }, "address2": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "stateProvince": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } }, "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "contactType": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ], "format": "email" }, "phone": { "type": [ "null", "string" ] }, "mobilePhone": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantContacts" ], "operationId": "developerPutV1AppsModulesContactsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantContacts" ], "operationId": "developerDeleteV1AppsModulesContactsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/contacts/{recordId}/favorite": { "put": { "tags": [ "TenantContacts" ], "operationId": "developerPutV1AppsModulesContactsRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations": { "get": { "tags": [ "TenantConversations" ], "operationId": "developerGetV1AppsModulesConversations", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "channelTypeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "awaitingReplyOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "conversationId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "channelTypeId": { "type": "integer", "format": "int32" }, "channelKey": { "type": [ "null", "string" ] }, "channelName": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedToDisplayName": { "type": [ "null", "string" ] }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactDisplayName": { "type": [ "null", "string" ] }, "lastMessageUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessagePreview": { "type": [ "null", "string" ] }, "messageCount": { "type": "integer", "format": "int32" }, "isAwaitingReply": { "type": "boolean" }, "snoozeUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "slaStatus": { "type": [ "null", "string" ] }, "resolutionSlaStatus": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isUnread": { "type": "boolean" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantConversations" ], "operationId": "developerPostV1AppsModulesConversations", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConversationCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConversationCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "conversationMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "duplicate": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/{recordId}": { "get": { "tags": [ "TenantConversations" ], "operationId": "developerGetV1AppsModulesConversationsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messagePageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "beforeUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "isOutboundCapable": { "type": "boolean" }, "firstResponseDueUtc": { "type": [ "null", "string" ], "format": "date-time" }, "firstResponseAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "resolutionDueUtc": { "type": [ "null", "string" ], "format": "date-time" }, "resolutionAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "participants": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "participantKey": { "type": [ "null", "string" ] }, "participantType": { "type": "integer", "format": "int32" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "lastReadUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isMuted": { "type": "boolean" } } } }, "tags": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "tagId": { "type": "string", "format": "uuid" }, "tagKey": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "colorKey": { "type": [ "null", "string" ] } } } }, "messages": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "conversationMessageId": { "type": "string", "format": "uuid" }, "direction": { "type": [ "null", "string" ] }, "fromAddress": { "type": [ "null", "string" ] }, "toAddress": { "type": [ "null", "string" ] }, "ccAddress": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "bodyHtml": { "type": [ "null", "string" ] }, "postedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "postedByDisplayName": { "type": [ "null", "string" ] }, "deliveryStatus": { "type": [ "null", "string" ] }, "hasAttachments": { "type": "boolean" }, "isPrivateNote": { "type": "boolean" }, "sentUtc": { "type": [ "null", "string" ], "format": "date-time" }, "receivedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "attachments": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "fileName": { "type": [ "null", "string" ] }, "contentType": { "type": [ "null", "string" ] }, "sizeBytes": { "type": "integer", "format": "int64" }, "isInline": { "type": "boolean" }, "contentId": { "type": [ "null", "string" ] } } } } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "conversationId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "channelTypeId": { "type": "integer", "format": "int32" }, "channelKey": { "type": [ "null", "string" ] }, "channelName": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedToDisplayName": { "type": [ "null", "string" ] }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactDisplayName": { "type": [ "null", "string" ] }, "lastMessageUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessagePreview": { "type": [ "null", "string" ] }, "messageCount": { "type": "integer", "format": "int32" }, "isAwaitingReply": { "type": "boolean" }, "snoozeUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "slaStatus": { "type": [ "null", "string" ] }, "resolutionSlaStatus": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isUnread": { "type": "boolean" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantConversations" ], "operationId": "developerPutV1AppsModulesConversationsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConversationUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConversationUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "conversationMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "duplicate": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantConversations" ], "operationId": "developerDeleteV1AppsModulesConversationsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/lego-catalog": { "get": { "tags": [ "TenantConversations" ], "operationId": "developerGetV1AppsModulesConversationsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/lego-presentation": { "get": { "tags": [ "TenantConversations" ], "operationId": "developerGetV1AppsModulesConversationsLegoPresentation", "parameters": [ { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "conversationId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "channelTypeId": { "type": "integer", "format": "int32" }, "channelKey": { "type": [ "null", "string" ] }, "channelName": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedToDisplayName": { "type": [ "null", "string" ] }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactDisplayName": { "type": [ "null", "string" ] }, "lastMessageUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessagePreview": { "type": [ "null", "string" ] }, "messageCount": { "type": "integer", "format": "int32" }, "isAwaitingReply": { "type": "boolean" }, "snoozeUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "slaStatus": { "type": [ "null", "string" ] }, "resolutionSlaStatus": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isUnread": { "type": "boolean" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/capabilities": { "get": { "tags": [ "TenantConversations" ], "operationId": "developerGetV1AppsModulesConversationsCapabilities", "parameters": [ { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/{recordId}/messages": { "post": { "tags": [ "TenantConversations" ], "operationId": "developerPostV1AppsModulesConversationsRecordIdGuidMessages", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationMessageWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConversationMessageWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConversationMessageWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "conversationMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "duplicate": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/direct": { "post": { "tags": [ "TenantConversations" ], "operationId": "developerPostV1AppsModulesConversationsDirect", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectConversationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DirectConversationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DirectConversationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "conversationMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "duplicate": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/conversations/{recordId}/favorite": { "put": { "tags": [ "TenantConversations" ], "operationId": "developerPutV1AppsModulesConversationsRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConversationFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConversationFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "conversationMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] }, "duplicate": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards": { "get": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerGetV1AppsModulesDiscussionBoards", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "discussionBoardId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "boardName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" }, "topicCount": { "type": "integer", "format": "int32" }, "postCount": { "type": "integer", "format": "int32" }, "lastTopicUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPostV1AppsModulesDiscussionBoards", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionBoardWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionBoardWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionBoardWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/{recordId}": { "get": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerGetV1AppsModulesDiscussionBoardsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "status": { "type": [ "null", "string" ] }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canCreateTopic": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "topics": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "discussionTopicId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "topicTitle": { "type": [ "null", "string" ] }, "isPinned": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" }, "postCount": { "type": "integer", "format": "int32" }, "lastPostUtc": { "type": [ "null", "string" ], "format": "date-time" } } } }, "discussionBoardId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "boardName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" }, "topicCount": { "type": "integer", "format": "int32" }, "postCount": { "type": "integer", "format": "int32" }, "lastTopicUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPutV1AppsModulesDiscussionBoardsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionBoardWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionBoardWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionBoardWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerDeleteV1AppsModulesDiscussionBoardsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "discussionBoardId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/lego/catalog": { "get": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerGetV1AppsModulesDiscussionBoardsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/{boardRecordId}/topics": { "post": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPostV1AppsModulesDiscussionBoardsBoardRecordIdGuidTopics", "parameters": [ { "name": "boardRecordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionTopicCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionTopicCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionTopicCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/topics/{recordId}": { "get": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerGetV1AppsModulesDiscussionBoardsTopicsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "boardRecordId": { "type": "string", "format": "uuid" }, "boardName": { "type": [ "null", "string" ] }, "isBoardArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canReply": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "posts": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "discussionPostId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "parentDiscussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postBody": { "type": [ "null", "string" ] }, "postedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "postedByDisplayName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } } }, "discussionTopicId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "topicTitle": { "type": [ "null", "string" ] }, "isPinned": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" }, "postCount": { "type": "integer", "format": "int32" }, "lastPostUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPutV1AppsModulesDiscussionBoardsTopicsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionTopicUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionTopicUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionTopicUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerDeleteV1AppsModulesDiscussionBoardsTopicsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "discussionTopicId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/topics/{topicRecordId}/posts": { "post": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPostV1AppsModulesDiscussionBoardsTopicsTopicRecordIdGuidPosts", "parameters": [ { "name": "topicRecordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionPostWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionPostWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionPostWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/posts/{recordId}": { "put": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPutV1AppsModulesDiscussionBoardsPostsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionPostUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionPostUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionPostUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerDeleteV1AppsModulesDiscussionBoardsPostsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "discussionPostId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/discussion-boards/records/{recordId}/favorite": { "put": { "tags": [ "TenantDiscussionBoards" ], "operationId": "developerPutV1AppsModulesDiscussionBoardsRecordsRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussionFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscussionFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscussionFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "boardRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "topicRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionBoardId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionTopicId": { "type": [ "null", "string" ], "format": "uuid" }, "discussionPostId": { "type": [ "null", "string" ], "format": "uuid" }, "postRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic": { "get": { "tags": [ "TenantDynamicModules" ], "operationId": "developerGetV1AppsModulesDynamic", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "modules": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "moduleKey": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "storageMode": { "type": [ "null", "string" ] }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/{moduleKey}/schema": { "get": { "tags": [ "TenantDynamicModules" ], "operationId": "developerGetV1AppsModulesDynamicModuleKeySchema", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "storageMode": { "type": [ "null", "string" ] }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "required": { "type": "boolean" }, "searchable": { "type": "boolean" }, "sortable": { "type": "boolean" }, "maxLength": { "type": [ "null", "integer" ], "format": "int32" }, "validationRegex": { "type": [ "null", "string" ] }, "options": { } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/{moduleKey}/lookups/{lookupId}": { "get": { "tags": [ "TenantDynamicModules" ], "operationId": "developerGetV1AppsModulesDynamicModuleKeyLookupsLookupIdGuid", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/{moduleKey}/lego/catalog": { "get": { "tags": [ "TenantDynamicModules" ], "operationId": "developerGetV1AppsModulesDynamicModuleKeyLegoCatalog", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "storageMode": { "type": [ "null", "string" ] }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "required": { "type": "boolean" }, "searchable": { "type": "boolean" }, "sortable": { "type": "boolean" }, "maxLength": { "type": [ "null", "integer" ], "format": "int32" }, "validationRegex": { "type": [ "null", "string" ] }, "options": { } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/{moduleKey}": { "get": { "tags": [ "TenantDynamicModules" ], "operationId": "developerGetV1AppsModulesDynamicModuleKey", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "default": "created_desc" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "records": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } } } } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int64" }, "hasMore": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantDynamicModules" ], "operationId": "developerPostV1AppsModulesDynamicModuleKey", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicModuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicModuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DynamicModuleWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/{moduleKey}/{recordId}": { "get": { "tags": [ "TenantDynamicModules" ], "operationId": "developerGetV1AppsModulesDynamicModuleKeyRecordIdGuid", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int64" }, "activityCount": { "type": "integer", "format": "int64" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantDynamicModules" ], "operationId": "developerPutV1AppsModulesDynamicModuleKeyRecordIdGuid", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicModuleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicModuleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DynamicModuleWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantDynamicModules" ], "operationId": "developerDeleteV1AppsModulesDynamicModuleKeyRecordIdGuid", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectedUpdatedUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/{moduleKey}/{recordId}/favorite": { "put": { "tags": [ "TenantDynamicModules" ], "operationId": "developerPutV1AppsModulesDynamicModuleKeyRecordIdGuidFavorite", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicModuleFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DynamicModuleFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DynamicModuleFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/dynamic/caseflow-cases/{recordId}/transition": { "post": { "tags": [ "TenantDynamicModules" ], "operationId": "developerPostV1AppsModulesDynamicCaseflowCasesRecordIdGuidTransition", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseFlowTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CaseFlowTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CaseFlowTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "caseRecordId": { "type": "string", "format": "uuid" }, "transitionRecordId": { "type": "string", "format": "uuid" }, "previousStage": { "type": [ "null", "string" ] }, "currentStage": { "type": [ "null", "string" ] }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites/schema": { "get": { "tags": [ "TenantFavorites" ], "operationId": "developerGetV1AppsModulesFavoritesSchema", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites/presentation": { "get": { "tags": [ "TenantFavorites" ], "operationId": "developerGetV1AppsModulesFavoritesPresentation", "parameters": [ { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "trackedOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites": { "get": { "tags": [ "TenantFavorites" ], "operationId": "developerGetV1AppsModulesFavorites", "parameters": [ { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "trackedOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "modules": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] } } } }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "userFavoriteId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "favoriteName": { "type": [ "null", "string" ] }, "recordTitle": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "iconKey": { "type": [ "null", "string" ] }, "sortOrder": { "type": "integer", "format": "int32" }, "isPinned": { "type": "boolean" }, "trackChanges": { "type": "boolean" }, "notificationFrequency": { "type": [ "null", "string" ] }, "notificationChannel": { "type": [ "null", "string" ] }, "lastNotifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites/{recordId}": { "get": { "tags": [ "TenantFavorites" ], "operationId": "developerGetV1AppsModulesFavoritesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "relatedRecords": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordRelationId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "relationKey": { "type": [ "null", "string" ] }, "relationName": { "type": [ "null", "string" ] } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } }, "userFavoriteId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "favoriteName": { "type": [ "null", "string" ] }, "recordTitle": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "iconKey": { "type": [ "null", "string" ] }, "sortOrder": { "type": "integer", "format": "int32" }, "isPinned": { "type": "boolean" }, "trackChanges": { "type": "boolean" }, "notificationFrequency": { "type": [ "null", "string" ] }, "notificationChannel": { "type": [ "null", "string" ] }, "lastNotifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites/{recordId}/state": { "get": { "tags": [ "TenantFavorites" ], "operationId": "developerGetV1AppsModulesFavoritesRecordIdGuidState", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "userFavoriteId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isPinned": { "type": [ "null", "boolean" ] }, "trackChanges": { "type": [ "null", "boolean" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites/{recordId}/favorite": { "put": { "tags": [ "TenantFavorites" ], "operationId": "developerPutV1AppsModulesFavoritesRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteSetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FavoriteSetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FavoriteSetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "userFavoriteId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isPinned": { "type": [ "null", "boolean" ] }, "trackChanges": { "type": [ "null", "boolean" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/favorites/{recordId}/preferences": { "put": { "tags": [ "TenantFavorites" ], "operationId": "developerPutV1AppsModulesFavoritesRecordIdGuidPreferences", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoritePreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FavoritePreferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FavoritePreferenceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "userFavoriteId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isPinned": { "type": [ "null", "boolean" ] }, "trackChanges": { "type": [ "null", "boolean" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files": { "get": { "tags": [ "TenantFiles" ], "operationId": "developerGetV1AppsModulesFiles", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "contentTypePrefix", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "fileName": { "type": [ "null", "string" ] }, "contentType": { "type": [ "null", "string" ] }, "sizeBytes": { "type": "integer", "format": "int64" }, "description": { "type": [ "null", "string" ] }, "version": { "type": "integer", "format": "int32" }, "hasPreview": { "type": "boolean" }, "uploadedUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "uploadedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "uploadedByDisplayName": { "type": [ "null", "string" ] }, "attachmentCount": { "type": "integer", "format": "int32" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/capabilities": { "get": { "tags": [ "TenantFiles" ], "operationId": "developerGetV1AppsModulesFilesCapabilities", "parameters": [ { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/{recordId}": { "get": { "tags": [ "TenantFiles" ], "operationId": "developerGetV1AppsModulesFilesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checksumSha256": { "type": [ "null", "string" ] }, "parentFileId": { "type": [ "null", "string" ], "format": "uuid" }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "createdUtc": { "type": "string", "format": "date-time" }, "status": { "type": [ "null", "string" ] }, "relationCount": { "type": "integer", "format": "int32" }, "commentCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "attachments": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "attachmentId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": "string", "format": "uuid" }, "sourceModuleKey": { "type": [ "null", "string" ] }, "sourceTitle": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" }, "createdUtc": { "type": "string", "format": "date-time" } } } }, "activeLocks": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "lockedByUserId": { "type": "string", "format": "uuid" }, "lockedByDisplayName": { "type": [ "null", "string" ] }, "lockedUtc": { "type": "string", "format": "date-time" }, "expiresUtc": { "type": "string", "format": "date-time" } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "fileId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "fileName": { "type": [ "null", "string" ] }, "contentType": { "type": [ "null", "string" ] }, "sizeBytes": { "type": "integer", "format": "int64" }, "description": { "type": [ "null", "string" ] }, "version": { "type": "integer", "format": "int32" }, "hasPreview": { "type": "boolean" }, "uploadedUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "uploadedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "uploadedByDisplayName": { "type": [ "null", "string" ] }, "attachmentCount": { "type": "integer", "format": "int32" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantFiles" ], "operationId": "developerPutV1AppsModulesFilesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "fileId": { "type": [ "null", "string" ], "format": "uuid" }, "attachmentId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantFiles" ], "operationId": "developerDeleteV1AppsModulesFilesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectedUpdatedUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "retentionUntilUtc": { "type": "string", "format": "date-time" }, "cleanupJobsQueued": { "type": "integer", "format": "int32" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/upload": { "post": { "tags": [ "TenantFiles" ], "operationId": "developerPostV1AppsModulesFilesUpload", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "$ref": "#/components/schemas/IFormFile" }, "LocationId": { "type": "string", "format": "uuid" }, "Description": { "type": "string" }, "TagsJson": { "type": "string" }, "SourceRecordId": { "type": "string", "format": "uuid" }, "SourceModuleKey": { "type": "string" }, "DynamicFieldsJson": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "fileId": { "type": [ "null", "string" ], "format": "uuid" }, "attachmentId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/{recordId}/attachments": { "post": { "tags": [ "TenantFiles" ], "operationId": "developerPostV1AppsModulesFilesRecordIdGuidAttachments", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileAttachmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileAttachmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileAttachmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "fileId": { "type": [ "null", "string" ], "format": "uuid" }, "attachmentId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/{recordId}/attachments/{attachmentId}": { "delete": { "tags": [ "TenantFiles" ], "operationId": "developerDeleteV1AppsModulesFilesRecordIdGuidAttachmentsAttachmentIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "fileId": { "type": [ "null", "string" ], "format": "uuid" }, "attachmentId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/{recordId}/favorite": { "put": { "tags": [ "TenantFiles" ], "operationId": "developerPutV1AppsModulesFilesRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "fileId": { "type": [ "null", "string" ], "format": "uuid" }, "attachmentId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/lego/catalog": { "get": { "tags": [ "TenantFiles" ], "operationId": "developerGetV1AppsModulesFilesLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/files/{recordId}/content": { "get": { "tags": [ "TenantFiles" ], "operationId": "developerGetV1AppsModulesFilesRecordIdGuidContent", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/global-search": { "get": { "tags": [ "TenantGlobalSearch" ], "description": "Returns fast authorized rows within the 5,000-record browse window. Non-exact totalRecords is not a full count. Fetch the exact total separately with GET /v1/apps/{saasAppId}/modules/global-search/count using the same filters and identity. Legacy includeTotal=true requests return HTTP 400 with code global_search_count_endpoint_required. Omitted or false is accepted. Keep rows usable if the separate count request fails; never report a failed count as zero.", "operationId": "developerGetV1AppsModulesGlobalSearch", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "browseLimit": { "type": "integer", "format": "int32" }, "query": { "type": [ "null", "string" ] }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "modules": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] } } } }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "matchKind": { "type": [ "null", "string" ] }, "matchRank": { "type": "integer", "format": "int32" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "matchedFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "matchedValue": { "type": [ "null", "string" ] } } } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/global-search/count": { "get": { "tags": [ "TenantGlobalSearch" ], "operationId": "developerGetV1AppsModulesGlobalSearchCount", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalIsExact": { "type": "boolean" }, "browseLimit": { "type": "integer", "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/global-search/records/{recordId}/favorite": { "put": { "tags": [ "TenantGlobalSearch" ], "operationId": "developerPutV1AppsModulesGlobalSearchRecordsRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GlobalSearchFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "userFavoriteId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isPinned": { "type": [ "null", "boolean" ] }, "trackChanges": { "type": [ "null", "boolean" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals": { "get": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerGetV1AppsGoclawApprovals", "parameters": [ { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "suggestionBatchId", "inboxItemId", "batchStatus", "summary", "intent", "riskLevel", "overallConfidence", "basedOnActivityVersion", "preparedUtc", "activityVersion", "sourceType", "subject", "previewText", "priority", "lastActivityUtc", "isStale", "draftResponseJson" ], "type": "object", "properties": { "suggestionBatchId": { "type": "string", "format": "uuid" }, "inboxItemId": { "type": "string", "format": "uuid" }, "batchStatus": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "intent": { "type": [ "null", "string" ] }, "riskLevel": { "type": [ "null", "string" ] }, "overallConfidence": { "type": [ "null", "number" ], "format": "double" }, "basedOnActivityVersion": { "type": "integer", "format": "int64" }, "preparedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "activityVersion": { "type": "integer", "format": "int64" }, "sourceType": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "previewText": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "uint8" }, "lastActivityUtc": { "type": "string", "format": "date-time" }, "isStale": { "type": "boolean" }, "draftResponseJson": { "type": [ "null", "string" ] }, "suggestedActions": { "type": [ "null", "array" ], "items": { "required": [ "aiActionSuggestionId", "actionKey", "actionName", "confidenceScore", "suggestedInputJson" ], "type": "object", "properties": { "aiActionSuggestionId": { "type": "string", "format": "uuid" }, "actionKey": { "type": [ "null", "string" ] }, "actionName": { "type": [ "null", "string" ] }, "confidenceScore": { "type": [ "null", "number" ], "format": "double" }, "suggestedInputJson": { "type": [ "null", "string" ] } } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals/lego/catalog": { "get": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerGetV1AppsGoclawApprovalsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals/lego/presentation": { "get": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerGetV1AppsGoclawApprovalsLegoPresentation", "parameters": [ { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "suggestionBatchId", "inboxItemId", "batchStatus", "summary", "intent", "riskLevel", "overallConfidence", "basedOnActivityVersion", "preparedUtc", "activityVersion", "sourceType", "subject", "previewText", "priority", "lastActivityUtc", "isStale", "draftResponseJson" ], "type": "object", "properties": { "suggestionBatchId": { "type": "string", "format": "uuid" }, "inboxItemId": { "type": "string", "format": "uuid" }, "batchStatus": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "intent": { "type": [ "null", "string" ] }, "riskLevel": { "type": [ "null", "string" ] }, "overallConfidence": { "type": [ "null", "number" ], "format": "double" }, "basedOnActivityVersion": { "type": "integer", "format": "int64" }, "preparedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "activityVersion": { "type": "integer", "format": "int64" }, "sourceType": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "previewText": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "uint8" }, "lastActivityUtc": { "type": "string", "format": "date-time" }, "isStale": { "type": "boolean" }, "draftResponseJson": { "type": [ "null", "string" ] }, "suggestedActions": { "type": [ "null", "array" ], "items": { "required": [ "aiActionSuggestionId", "actionKey", "actionName", "confidenceScore", "suggestedInputJson" ], "type": "object", "properties": { "aiActionSuggestionId": { "type": "string", "format": "uuid" }, "actionKey": { "type": [ "null", "string" ] }, "actionName": { "type": [ "null", "string" ] }, "confidenceScore": { "type": [ "null", "number" ], "format": "double" }, "suggestedInputJson": { "type": [ "null", "string" ] } } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals/{suggestionBatchId}/approve": { "post": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerPostV1AppsGoclawApprovalsSuggestionBatchIdGuidApprove", "parameters": [ { "name": "suggestionBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantApproveSuggestionBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantApproveSuggestionBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantApproveSuggestionBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "suggestionBatchId" ], "type": "object", "properties": { "suggestionBatchId": { "type": "string", "format": "uuid" }, "executions": { "type": [ "null", "array" ], "items": { "required": [ "aiActionExecutionId", "aiActionSuggestionId", "actionKey" ], "type": "object", "properties": { "aiActionExecutionId": { "type": "string", "format": "uuid" }, "aiActionSuggestionId": { "type": "string", "format": "uuid" }, "actionKey": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals/{suggestionBatchId}/reject": { "post": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerPostV1AppsGoclawApprovalsSuggestionBatchIdGuidReject", "parameters": [ { "name": "suggestionBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRejectSuggestionBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRejectSuggestionBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantRejectSuggestionBatchRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals/{suggestionBatchId}/take-over": { "post": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerPostV1AppsGoclawApprovalsSuggestionBatchIdGuidTakeOver", "parameters": [ { "name": "suggestionBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantReviewDispositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantReviewDispositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantReviewDispositionRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/goclaw/approvals/{suggestionBatchId}/retry": { "post": { "tags": [ "TenantGoClawApprovals" ], "operationId": "developerPostV1AppsGoclawApprovalsSuggestionBatchIdGuidRetry", "parameters": [ { "name": "suggestionBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantReviewDispositionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantReviewDispositionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantReviewDispositionRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-articles": { "get": { "tags": [ "TenantKnowledgeArticles" ], "operationId": "developerGetV1AppsModulesKnowledgeArticles", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeDrafts", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canEdit": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "isPublished": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantKnowledgeArticles" ], "operationId": "developerPostV1AppsModulesKnowledgeArticles", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-articles/{recordId}": { "get": { "tags": [ "TenantKnowledgeArticles" ], "operationId": "developerGetV1AppsModulesKnowledgeArticlesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "articleBody": { "type": [ "null", "string" ] }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "isPublished": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantKnowledgeArticles" ], "operationId": "developerPutV1AppsModulesKnowledgeArticlesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantKnowledgeArticles" ], "description": "Removes an authorized Knowledge article using its latest expectedUpdatedUtc revision. Missing or invalid input returns 400; an unavailable target returns 404 (knowledge_articles_not_found); a stale revision returns 409 (knowledge_articles_conflict). Refresh the article and ask the user to confirm again after a conflict; do not blindly retry with a new revision.", "operationId": "developerDeleteV1AppsModulesKnowledgeArticlesRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectedUpdatedUtc", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-articles/{recordId}/favorite": { "put": { "tags": [ "TenantKnowledgeArticles" ], "operationId": "developerPutV1AppsModulesKnowledgeArticlesRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeArticleFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-articles/lego/catalog": { "get": { "tags": [ "TenantKnowledgeArticles" ], "operationId": "developerGetV1AppsModulesKnowledgeArticlesLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCore", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "lifecycleStatus", "in": "query", "schema": { "type": "string" } }, { "name": "knowledgeType", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canCreate": { "type": "boolean" }, "canManage": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "slug": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" }, "freshnessStatus": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCore", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "articleBody": { "type": [ "null", "string" ] }, "reviewPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "lastReviewedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "canEdit": { "type": "boolean" }, "canPublish": { "type": "boolean" }, "canArchive": { "type": "boolean" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "slug": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" }, "freshnessStatus": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPutV1AppsModulesKnowledgeCoreRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}/publish": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreRecordIdGuidPublish", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}/archive": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreRecordIdGuidArchive", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}/revisions": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreRecordIdGuidRevisions", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeRevisionId": { "type": "string", "format": "uuid" }, "revisionNumber": { "type": "integer", "format": "int32" }, "title": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "contentHash": { "type": [ "null", "string" ] }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}/restore": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreRecordIdGuidRestore", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreRestoreRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreRestoreRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreRestoreRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/collections": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreCollections", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "collectionId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "parentCollectionId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultReviewPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "isSupportCollection": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "itemCount": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreCollections", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreCollectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreCollectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreCollectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "collectionId": { "type": "string", "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/collections/{collectionId}": { "put": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPutV1AppsModulesKnowledgeCoreCollectionsCollectionIdGuid", "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreCollectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreCollectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreCollectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "collectionId": { "type": "string", "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/collections/{collectionId}/items/{recordId}": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreCollectionsCollectionIdGuidItemsRecordIdGuid", "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "collectionId": { "type": "string", "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerDeleteV1AppsModulesKnowledgeCoreCollectionsCollectionIdGuidItemsRecordIdGuid", "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "collectionId": { "type": "string", "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}/owners": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreRecordIdGuidOwners", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeOwnerId": { "type": "string", "format": "uuid" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "dataRoleName": { "type": [ "null", "string" ] }, "responsibilityType": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" }, "assignedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreRecordIdGuidOwners", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreOwnerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreOwnerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeCoreOwnerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeOwnerId": { "type": "string", "format": "uuid" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/owners/{knowledgeOwnerId}": { "delete": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerDeleteV1AppsModulesKnowledgeCoreOwnersKnowledgeOwnerIdGuid", "parameters": [ { "name": "knowledgeOwnerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeOwnerId": { "type": "string", "format": "uuid" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/unowned": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreUnowned", "parameters": [ { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canCreate": { "type": "boolean" }, "canManage": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "slug": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "currentRevisionNumber": { "type": "integer", "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" }, "freshnessStatus": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/assignment-lookup": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreAssignmentLookup", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "topN", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "users": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "id": { }, "label": { "type": [ "null", "string" ] }, "targetType": { "type": [ "null", "string" ] } } } }, "roles": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "id": { }, "label": { "type": [ "null", "string" ] }, "targetType": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/reviews": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreReviews", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canManage": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "reviewCycleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "dueUtc": { "type": "string", "format": "date-time" }, "status": { "type": [ "null", "string" ] }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "taskRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/reviews/{reviewCycleId}/begin": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreReviewsReviewCycleIdGuidBegin", "parameters": [ { "name": "reviewCycleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "reviewCycleId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/reviews/{reviewCycleId}/complete": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreReviewsReviewCycleIdGuidComplete", "parameters": [ { "name": "reviewCycleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewTransitionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewTransitionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "reviewCycleId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/reviews/{reviewCycleId}/reassign": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreReviewsReviewCycleIdGuidReassign", "parameters": [ { "name": "reviewCycleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewReassignRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewReassignRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeReviewReassignRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "reviewCycleId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/health": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreHealth", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "calculatedUtc": { "type": "string", "format": "date-time" }, "publishedCount": { "type": "integer", "format": "int32" }, "draftCount": { "type": "integer", "format": "int32" }, "archivedCount": { "type": "integer", "format": "int32" }, "reviewDueCount": { "type": "integer", "format": "int32" }, "dueSoonCount": { "type": "integer", "format": "int32" }, "staleCount": { "type": "integer", "format": "int32" }, "unownedCount": { "type": "integer", "format": "int32" }, "openQuestionCount": { "type": "integer", "format": "int32" }, "knowledgeGapCandidateCount": { "type": "integer", "format": "int32" }, "outdatedOrIncorrectFeedbackCount": { "type": "integer", "format": "int32" }, "supportCandidateCount": { "type": "integer", "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/questions": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreQuestions", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canAnswer": { "type": "boolean" }, "canManage": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeQuestionId": { "type": "string", "format": "uuid" }, "contextRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "questionText": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "answerText": { "type": [ "null", "string" ] }, "answerKnowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "occurrenceCount": { "type": "integer", "format": "int32" }, "createdUtc": { "type": "string", "format": "date-time" }, "answeredUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreQuestions", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeQuestionId": { "type": "string", "format": "uuid" }, "occurrenceId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "duplicateGroupKey": { "type": [ "null", "string" ] }, "answerKnowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "answeredUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "replayed": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/questions/{knowledgeQuestionId}/assign": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreQuestionsKnowledgeQuestionIdGuidAssign", "parameters": [ { "name": "knowledgeQuestionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionAssignRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionAssignRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionAssignRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeQuestionId": { "type": "string", "format": "uuid" }, "occurrenceId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "duplicateGroupKey": { "type": [ "null", "string" ] }, "answerKnowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "answeredUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "replayed": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/questions/{knowledgeQuestionId}/answer": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreQuestionsKnowledgeQuestionIdGuidAnswer", "parameters": [ { "name": "knowledgeQuestionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionAnswerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeQuestionId": { "type": "string", "format": "uuid" }, "occurrenceId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "duplicateGroupKey": { "type": [ "null", "string" ] }, "answerKnowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "answeredUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "replayed": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/questions/{knowledgeQuestionId}/convert": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreQuestionsKnowledgeQuestionIdGuidConvert", "parameters": [ { "name": "knowledgeQuestionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionConvertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionConvertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeQuestionConvertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeQuestionId": { "type": "string", "format": "uuid" }, "occurrenceId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "duplicateGroupKey": { "type": [ "null", "string" ] }, "answerKnowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeArticleId": { "type": [ "null", "string" ], "format": "uuid" }, "answeredUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "replayed": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/{recordId}/feedback": { "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreRecordIdGuidFeedback", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeFeedbackRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeFeedbackRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeFeedbackRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeFeedbackId": { "type": "string", "format": "uuid" }, "knowledgeRecordId": { "type": "string", "format": "uuid" }, "feedbackType": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreRecordIdGuidFeedback", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "knowledgeRecordId": { "type": "string", "format": "uuid" }, "totalCount": { "type": "integer", "format": "int32" }, "helpfulCount": { "type": "integer", "format": "int32" }, "notHelpfulCount": { "type": "integer", "format": "int32" }, "outdatedCount": { "type": "integer", "format": "int32" }, "incorrectCount": { "type": "integer", "format": "int32" }, "missingDetailCount": { "type": "integer", "format": "int32" }, "conflictingCount": { "type": "integer", "format": "int32" }, "latestFeedbackUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/gaps": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreGaps", "parameters": [ { "name": "days", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 90 } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "sinceUtc": { "type": "string", "format": "date-time" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "gapType": { "type": [ "null", "string" ] }, "gapKey": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "supportingCount": { "type": "integer", "format": "int32" }, "openCount": { "type": "integer", "format": "int32" }, "knowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "latestSignalUtc": { "type": "string", "format": "date-time" }, "sourceLinks": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "knowledgeQuestionId": { "type": [ "null", "string" ], "format": "uuid" }, "contextRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "href": { "type": [ "null", "string" ] } } } } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/knowledge-core/support-learning/candidates": { "get": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerGetV1AppsModulesKnowledgeCoreSupportLearningCandidates", "parameters": [ { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "supportResolutionLinkId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "reviewTaskRecordId": { "type": "string", "format": "uuid" }, "sourceInboxItemId": { "type": "string", "format": "uuid" }, "sourceActivityVersion": { "type": "integer", "format": "int64" }, "sanitizationPolicyVersion": { "type": [ "null", "string" ] }, "candidateContentHash": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantKnowledgeCore" ], "operationId": "developerPostV1AppsModulesKnowledgeCoreSupportLearningCandidates", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportResolutionCandidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportResolutionCandidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportResolutionCandidateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "supportResolutionLinkId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "reviewTaskRecordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "candidateContentHash": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" }, "replayed": { "type": "boolean" } } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/mail-reader": { "get": { "tags": [ "TenantMailReader" ], "operationId": "developerGetV1AppsModulesMailReader", "parameters": [ { "name": "mailAccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "unreadOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "accounts": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "mailAccountId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "emailAddress": { "type": [ "null", "string" ], "format": "email" }, "providerType": { "type": [ "null", "string" ] }, "isShared": { "type": "boolean" }, "messageCount": { "type": "integer", "format": "int32" }, "unreadCount": { "type": "integer", "format": "int32" } } } }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "mailReaderMessageId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "mailAccountId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "accountEmailAddress": { "type": [ "null", "string" ] }, "fromAddress": { "type": [ "null", "string" ] }, "toAddress": { "type": [ "null", "string" ] }, "ccAddress": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "previewText": { "type": [ "null", "string" ] }, "hasHtmlBody": { "type": "boolean" }, "receivedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isRead": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canMarkRead": { "type": "boolean" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/mail-reader/{recordId}": { "get": { "tags": [ "TenantMailReader" ], "operationId": "developerGetV1AppsModulesMailReaderRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "providerType": { "type": [ "null", "string" ] }, "isSharedAccount": { "type": "boolean" }, "bodyText": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } }, "mailReaderMessageId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "mailAccountId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "accountEmailAddress": { "type": [ "null", "string" ] }, "fromAddress": { "type": [ "null", "string" ] }, "toAddress": { "type": [ "null", "string" ] }, "ccAddress": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "previewText": { "type": [ "null", "string" ] }, "hasHtmlBody": { "type": "boolean" }, "receivedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isRead": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canMarkRead": { "type": "boolean" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/mail-reader/{recordId}/read": { "put": { "tags": [ "TenantMailReader" ], "operationId": "developerPutV1AppsModulesMailReaderRecordIdGuidRead", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailReaderReadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MailReaderReadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MailReaderReadRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "mailReaderMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "isRead": { "type": [ "null", "boolean" ] }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/mail-reader/{recordId}/favorite": { "put": { "tags": [ "TenantMailReader" ], "operationId": "developerPutV1AppsModulesMailReaderRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailReaderFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MailReaderFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MailReaderFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "mailReaderMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "isRead": { "type": [ "null", "boolean" ] }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/notifications": { "get": { "tags": [ "TenantNotifications" ], "operationId": "developerGetV1AppsModulesNotifications", "parameters": [ { "name": "unreadOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "unreadCount": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "notificationId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "notificationType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "actionUrl": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "uint8" }, "deliveryStatus": { "type": [ "null", "string" ] }, "isRead": { "type": "boolean" }, "isDismissed": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "sourceTitle": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "isSourceFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/notifications/lego-catalog": { "get": { "tags": [ "TenantNotifications" ], "operationId": "developerGetV1AppsModulesNotificationsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/notifications/lego-presentation": { "get": { "tags": [ "TenantNotifications" ], "operationId": "developerGetV1AppsModulesNotificationsLegoPresentation", "parameters": [ { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "unreadCount": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "notificationId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "notificationType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "actionUrl": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "uint8" }, "deliveryStatus": { "type": [ "null", "string" ] }, "isRead": { "type": "boolean" }, "isDismissed": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "sourceTitle": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "isSourceFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/notifications/{notificationId}": { "get": { "tags": [ "TenantNotifications" ], "operationId": "developerGetV1AppsModulesNotificationsNotificationIdGuid", "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "relationCount": { "type": "integer", "format": "int64" }, "activityCount": { "type": "integer", "format": "int64" }, "notificationId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "notificationType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "actionUrl": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "uint8" }, "deliveryStatus": { "type": [ "null", "string" ] }, "isRead": { "type": "boolean" }, "isDismissed": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "sourceTitle": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "isSourceFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/notifications/{notificationId}/state": { "put": { "tags": [ "TenantNotifications" ], "operationId": "developerPutV1AppsModulesNotificationsNotificationIdGuidState", "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationStateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "notificationId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "isRead": { "type": [ "null", "boolean" ] }, "isDismissed": { "type": [ "null", "boolean" ] }, "isSourceFavorite": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/notifications/{notificationId}/source-favorite": { "put": { "tags": [ "TenantNotifications" ], "operationId": "developerPutV1AppsModulesNotificationsNotificationIdGuidSourceFavorite", "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotificationFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NotificationFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "notificationId": { "type": "string", "format": "uuid" }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "isRead": { "type": [ "null", "boolean" ] }, "isDismissed": { "type": [ "null", "boolean" ] }, "isSourceFavorite": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/settings": { "get": { "tags": [ "TenantPayments" ], "operationId": "developerGetV1AppsModulesPaymentsSettings", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canManage": { "type": "boolean" }, "canCollect": { "type": "boolean" }, "policies": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "paymentPolicyId": { "type": "string", "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "collectionMode": { "type": [ "null", "string" ] }, "chargeTiming": { "type": [ "null", "string" ] }, "depositBasisPoints": { "type": "integer", "format": "int32" }, "currencyCode": { "type": [ "null", "string" ] }, "allowPartialPayments": { "type": "boolean" }, "minimumChargeCents": { "type": "integer", "format": "int64" }, "requirePaidBeforeCompletion": { "type": "boolean" }, "isActive": { "type": "boolean" }, "updatedUtc": { "type": "string", "format": "date-time" } } } }, "connectors": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "connectorId": { "type": "string", "format": "uuid" }, "connectorKey": { "type": [ "null", "string" ] }, "processor": { "type": [ "null", "string" ] }, "credentialReference": { "type": [ "null", "string" ] }, "webhookSecretReference": { "type": [ "null", "string" ] }, "isTestMode": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "modifiedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/settings/{moduleKey}": { "put": { "tags": [ "TenantPayments" ], "operationId": "developerPutV1AppsModulesPaymentsSettingsModuleKey", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantPaymentPolicyWrite" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantPaymentPolicyWrite" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantPaymentPolicyWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "paymentPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "connectorId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "amountCents": { "type": [ "null", "integer" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/connectors": { "put": { "tags": [ "TenantPayments" ], "operationId": "developerPutV1AppsModulesPaymentsConnectors", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantPaymentConnectorWrite" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantPaymentConnectorWrite" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantPaymentConnectorWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "paymentPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "connectorId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "amountCents": { "type": [ "null", "integer" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/connectors/{connectorId}": { "delete": { "tags": [ "TenantPayments" ], "operationId": "developerDeleteV1AppsModulesPaymentsConnectorsConnectorIdGuid", "parameters": [ { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "paymentPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "connectorId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "amountCents": { "type": [ "null", "integer" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/methods": { "get": { "tags": [ "TenantPayments" ], "operationId": "developerGetV1AppsModulesPaymentsMethods", "parameters": [ { "name": "customerRecordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "paymentMethodId": { "type": "string", "format": "uuid" }, "customerRecordId": { "type": "string", "format": "uuid" }, "processor": { "type": [ "null", "string" ] }, "methodType": { "type": [ "null", "string" ] }, "brand": { "type": [ "null", "string" ] }, "last4": { "type": [ "null", "string" ] }, "expMonth": { "type": [ "null", "integer" ], "format": "int32" }, "expYear": { "type": [ "null", "integer" ], "format": "int32" }, "isDefault": { "type": "boolean" }, "status": { "type": [ "null", "string" ] }, "consentCapturedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/records/{recordId}": { "get": { "tags": [ "TenantPayments" ], "operationId": "developerGetV1AppsModulesPaymentsRecordsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "expectedAmountCents": { "type": [ "null", "integer" ], "format": "int64" }, "paidAmountCents": { "type": "integer", "format": "int64" }, "dueAmountCents": { "type": [ "null", "integer" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "payments": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "paymentId": { "type": "string", "format": "uuid" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "paymentMethod": { "type": [ "null", "string" ] }, "externalPaymentId": { "type": [ "null", "string" ] }, "receivedUtc": { "type": "string", "format": "date-time" } } } }, "chargeIntents": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "chargeIntentId": { "type": "string", "format": "uuid" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "failureReason": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/payments/records/{recordId}/charges": { "post": { "tags": [ "TenantPayments" ], "operationId": "developerPostV1AppsModulesPaymentsRecordsRecordIdGuidCharges", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantChargeWrite" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantChargeWrite" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantChargeWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "paymentPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "connectorId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "moduleKey": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "amountCents": { "type": [ "null", "integer" ], "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-activity/records": { "get": { "tags": [ "TenantRecordActivity" ], "operationId": "developerGetV1AppsModulesRecordActivityRecords", "parameters": [ { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "afterTitle", "in": "query", "schema": { "type": "string" } }, { "name": "afterRecordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "nextTitle": { "type": [ "null", "string" ] }, "nextRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "modules": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] } } } }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-activity/{recordId}": { "get": { "tags": [ "TenantRecordActivity" ], "operationId": "developerGetV1AppsModulesRecordActivityRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "activityType", "in": "query", "schema": { "type": "string" } }, { "name": "fromUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "canAiRead": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "relationCount": { "type": "integer", "format": "int32" }, "activityTypes": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activityType": { "type": [ "null", "string" ] } } } }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "activityKey": { "type": [ "null", "string" ] }, "activityType": { "type": [ "null", "string" ] }, "sourceId": { "type": [ "null", "string" ], "format": "uuid" }, "occurredUtc": { "type": "string", "format": "date-time" }, "summary": { "type": [ "null", "string" ] }, "actorUserId": { "type": [ "null", "string" ], "format": "uuid" }, "actorDisplayName": { "type": [ "null", "string" ] }, "activityState": { "type": [ "null", "string" ] }, "detail": { } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-activity/{recordId}/favorite": { "put": { "tags": [ "TenantRecordActivity" ], "operationId": "developerPutV1AppsModulesRecordActivityRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordActivityFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordActivityFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordActivityFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "userFavoriteId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isPinned": { "type": [ "null", "boolean" ] }, "trackChanges": { "type": [ "null", "boolean" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/records": { "get": { "tags": [ "TenantRecordGraph" ], "operationId": "developerGetV1AppsModulesRecordGraphRecords", "parameters": [ { "name": "moduleKey", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } }, { "name": "afterTitle", "in": "query", "schema": { "type": "string" } }, { "name": "afterRecordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "nextTitle": { "type": [ "null", "string" ] }, "nextRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "modules": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] } } } }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/{recordId}": { "get": { "tags": [ "TenantRecordGraph" ], "operationId": "developerGetV1AppsModulesRecordGraphRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "maxDepth", "in": "query", "schema": { "maximum": 5, "minimum": 1, "type": "integer", "format": "int32", "default": 2 } }, { "name": "maxNodes", "in": "query", "schema": { "maximum": 200, "minimum": 2, "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "seedRecordId": { "type": "string", "format": "uuid" }, "depthReached": { "type": "integer", "format": "int32" }, "nodeCount": { "type": "integer", "format": "int32" }, "truncated": { "type": "boolean" }, "activityCount": { "type": "integer", "format": "int32" }, "nodes": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "depth": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } }, "edges": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordRelationId": { "type": "string", "format": "uuid" }, "fromRecordId": { "type": "string", "format": "uuid" }, "toRecordId": { "type": "string", "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" }, "relationKey": { "type": [ "null", "string" ] }, "relationName": { "type": [ "null", "string" ] } } } }, "relationTypes": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "relationKey": { "type": [ "null", "string" ] }, "relationName": { "type": [ "null", "string" ] } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/{recordId}/relations": { "put": { "tags": [ "TenantRecordGraph" ], "operationId": "developerPutV1AppsModulesRecordGraphRecordIdGuidRelations", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordGraphAddRelationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordGraphAddRelationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordGraphAddRelationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordRelationId": { "type": "string", "format": "uuid" }, "fromRecordId": { "type": "string", "format": "uuid" }, "toRecordId": { "type": "string", "format": "uuid" }, "relationKey": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/relations/{recordRelationId}": { "delete": { "tags": [ "TenantRecordGraph" ], "operationId": "developerDeleteV1AppsModulesRecordGraphRelationsRecordRelationIdGuid", "parameters": [ { "name": "recordRelationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordRelationId": { "type": "string", "format": "uuid" }, "fromRecordId": { "type": "string", "format": "uuid" }, "toRecordId": { "type": "string", "format": "uuid" }, "relationKey": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/{recordId}/favorite": { "put": { "tags": [ "TenantRecordGraph" ], "operationId": "developerPutV1AppsModulesRecordGraphRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordGraphFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordGraphFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordGraphFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "userFavoriteId": { "type": [ "null", "string" ], "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isPinned": { "type": [ "null", "boolean" ] }, "trackChanges": { "type": [ "null", "boolean" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/{recordId}/knowledge": { "get": { "tags": [ "TenantRecordGraph" ], "operationId": "developerGetV1AppsModulesRecordGraphRecordIdGuidKnowledge", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "maxItems", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordRelationId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "freshnessStatus": { "type": [ "null", "string" ] }, "relationKey": { "type": [ "null", "string" ] }, "relationName": { "type": [ "null", "string" ] }, "canAiRead": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantRecordGraph" ], "operationId": "developerPutV1AppsModulesRecordGraphRecordIdGuidKnowledge", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeRelationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KnowledgeRelationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KnowledgeRelationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordRelationId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "knowledgeRecordId": { "type": "string", "format": "uuid" }, "relationKey": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/{recordId}/knowledge/candidates": { "get": { "tags": [ "TenantRecordGraph" ], "operationId": "developerGetV1AppsModulesRecordGraphRecordIdGuidKnowledgeCandidates", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requireAiRead", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "maxCandidates", "in": "query", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "requireAiRead": { "type": "boolean" }, "maxCandidates": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "graphDistance": { "type": "integer", "format": "int32" }, "recordRelationId": { "type": [ "null", "string" ], "format": "uuid" }, "knowledgeRecordId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "freshnessStatus": { "type": [ "null", "string" ] }, "relationKey": { "type": [ "null", "string" ] }, "relationName": { "type": [ "null", "string" ] }, "canAiRead": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/record-graph/knowledge-relations/{recordRelationId}": { "delete": { "tags": [ "TenantRecordGraph" ], "operationId": "developerDeleteV1AppsModulesRecordGraphKnowledgeRelationsRecordRelationIdGuid", "parameters": [ { "name": "recordRelationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordRelationId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "knowledgeRecordId": { "type": "string", "format": "uuid" }, "relationKey": { "type": [ "null", "string" ] }, "created": { "type": [ "null", "boolean" ] }, "removed": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/products": { "get": { "tags": [ "TenantReservations" ], "operationId": "developerGetV1AppsModulesReservationsProducts", "parameters": [ { "name": "includeInactive", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "reservationProductId": { "type": "string", "format": "uuid" }, "productKey": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "durationMinutes": { "type": "integer", "format": "int32" }, "bufferBeforeMinutes": { "type": "integer", "format": "int32" }, "bufferAfterMinutes": { "type": "integer", "format": "int32" }, "priceCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "concurrentCapacity": { "type": "integer", "format": "int32" }, "maxPartySize": { "type": "integer", "format": "int32" }, "defaultLocationId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultLocationName": { "type": [ "null", "string" ] }, "defaultResourceId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultResourceName": { "type": [ "null", "string" ] }, "defaultAssignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultAssignedUserName": { "type": [ "null", "string" ] }, "enforceAssigneeExclusivity": { "type": "boolean" }, "holdMinutes": { "type": "integer", "format": "int32" }, "preServiceFollowupMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "postServiceFollowupMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "preServiceSubject": { "type": [ "null", "string" ] }, "postServiceSubject": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantReservations" ], "operationId": "developerPostV1AppsModulesReservationsProducts", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationProductWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReservationProductWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReservationProductWriteRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "calendarRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "idempotentReplay": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations": { "get": { "tags": [ "TenantReservations" ], "operationId": "developerGetV1AppsModulesReservations", "parameters": [ { "name": "windowStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "windowEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "assignedUserId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "reservationId": { "type": "string", "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ], "format": "email" }, "assignedUserId": { "type": "string", "format": "uuid" }, "assignedUserName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "timeZoneId": { "type": [ "null", "string" ] }, "partySize": { "type": "integer", "format": "int32" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "paymentStatus": { "type": [ "null", "string" ] }, "holdExpiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/assignees": { "get": { "tags": [ "TenantReservations" ], "description": "Returns eligible tenant users. Supply reservationProductId and startUtc together, with optional locationId; pageSize is 1–100. Choose an item.optionId and send it as assignedUserId on purchase or reschedule. lookupId identifies the lookup contract, not the assignee. Availability is rechecked on write.", "operationId": "developerGetV1AppsModulesReservationsAssignees", "parameters": [ { "name": "reservationProductId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 100 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "lookupId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "optionId": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/capabilities": { "get": { "tags": [ "TenantReservations" ], "operationId": "developerGetV1AppsModulesReservationsCapabilities", "parameters": [ { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/{recordId}": { "get": { "tags": [ "TenantReservations" ], "operationId": "developerGetV1AppsModulesReservationsRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "reservationProductId": { "type": "string", "format": "uuid" }, "contactRecordId": { "type": "string", "format": "uuid" }, "contactPhone": { "type": [ "null", "string" ] }, "calendarRecordId": { "type": "string", "format": "uuid" }, "calendarEventId": { "type": "string", "format": "uuid" }, "resourceBookingId": { "type": [ "null", "string" ], "format": "uuid" }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "paymentId": { "type": [ "null", "string" ], "format": "uuid" }, "sourceChannel": { "type": [ "null", "string" ] }, "customerNotes": { "type": [ "null", "string" ] }, "internalNotes": { "type": [ "null", "string" ] }, "cancellationReason": { "type": [ "null", "string" ] }, "cancelledUtc": { "type": [ "null", "string" ], "format": "date-time" }, "checkedInUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "followups": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "reservationFollowupId": { "type": "string", "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "scheduledUtc": { "type": "string", "format": "date-time" }, "recipientEmail": { "type": [ "null", "string" ], "format": "email" }, "subject": { "type": [ "null", "string" ] }, "deliveryStatus": { "type": [ "null", "string" ] }, "outboundMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "attemptCount": { "type": "integer", "format": "int32" }, "sentUtc": { "type": [ "null", "string" ], "format": "date-time" } } } }, "events": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "eventType": { "type": [ "null", "string" ] }, "actorUserId": { "type": [ "null", "string" ], "format": "uuid" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "detail": { }, "createdUtc": { "type": "string", "format": "date-time" } } } }, "recordId": { "type": "string", "format": "uuid" }, "reservationId": { "type": "string", "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ], "format": "email" }, "assignedUserId": { "type": "string", "format": "uuid" }, "assignedUserName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "timeZoneId": { "type": [ "null", "string" ] }, "partySize": { "type": "integer", "format": "int32" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "paymentStatus": { "type": [ "null", "string" ] }, "holdExpiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/purchase": { "post": { "tags": [ "TenantReservations" ], "description": "Creates an idempotent Reservation and returns HTTP 201. Use item.optionId from the assignee lookup as assignedUserId when selecting a tenant user. Capacity or assignee availability can change after lookup; HTTP 409 reservations_conflict requires refreshing choices.", "operationId": "developerPostV1AppsModulesReservationsPurchase", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationPurchaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReservationPurchaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReservationPurchaseRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "calendarRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "idempotentReplay": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/{recordId}/status": { "put": { "tags": [ "TenantReservations" ], "operationId": "developerPutV1AppsModulesReservationsRecordIdGuidStatus", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReservationStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReservationStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "calendarRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "idempotentReplay": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/{recordId}/schedule": { "put": { "tags": [ "TenantReservations" ], "description": "Reschedules with expectedUpdatedUtc and an eligible assignedUserId selected using the assignee lookup. Send that lookup's item.optionId, not lookupId. HTTP 409 reservations_conflict means refresh the Reservation and assignee choices before retrying.", "operationId": "developerPutV1AppsModulesReservationsRecordIdGuidSchedule", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationRescheduleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReservationRescheduleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReservationRescheduleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "calendarRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "idempotentReplay": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/{recordId}/followups": { "put": { "tags": [ "TenantReservations" ], "operationId": "developerPutV1AppsModulesReservationsRecordIdGuidFollowups", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationFollowupWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReservationFollowupWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReservationFollowupWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "calendarRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "idempotentReplay": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/reservations/lego/catalog": { "get": { "tags": [ "TenantReservations" ], "operationId": "developerGetV1AppsModulesReservationsLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/organization/snowflake": { "get": { "tags": [ "TenantSnowflake" ], "operationId": "developerGetV1AppsOrganizationSnowflake", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "exportAvailable": { "type": "boolean" }, "destination": { "type": "object", "properties": { "snowflakeDestinationId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": [ "null", "string" ] }, "warehouse": { "type": [ "null", "string" ] }, "databaseName": { "type": [ "null", "string" ] }, "schemaName": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "principalName": { "type": [ "null", "string" ] }, "authenticationType": { "type": [ "null", "string" ] }, "credentialProvider": { "type": [ "null", "string" ] }, "credentialConfigured": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "rowVersion": { "type": [ "null", "string" ] }, "publicKey": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastResult": { "type": [ "null", "string" ] }, "operationInProgress": { "type": "boolean" }, "runs": { }, "checkpoints": { } } }, "setupSql": { "type": [ "null", "string" ] }, "keyRotationSql": { "type": [ "null", "string" ] }, "ingestionMode": { "type": [ "null", "string" ] }, "schedulingAvailable": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantSnowflake" ], "operationId": "developerPutV1AppsOrganizationSnowflake", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSnowflakeSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantSnowflakeSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantSnowflakeSaveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "exportAvailable": { "type": "boolean" }, "destination": { "type": "object", "properties": { "snowflakeDestinationId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": [ "null", "string" ] }, "warehouse": { "type": [ "null", "string" ] }, "databaseName": { "type": [ "null", "string" ] }, "schemaName": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "principalName": { "type": [ "null", "string" ] }, "authenticationType": { "type": [ "null", "string" ] }, "credentialProvider": { "type": [ "null", "string" ] }, "credentialConfigured": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "rowVersion": { "type": [ "null", "string" ] }, "publicKey": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastResult": { "type": [ "null", "string" ] }, "operationInProgress": { "type": "boolean" }, "runs": { }, "checkpoints": { } } }, "setupSql": { "type": [ "null", "string" ] }, "keyRotationSql": { "type": [ "null", "string" ] }, "ingestionMode": { "type": [ "null", "string" ] }, "schedulingAvailable": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/organization/snowflake/test": { "post": { "tags": [ "TenantSnowflake" ], "operationId": "developerPostV1AppsOrganizationSnowflakeTest", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeOperationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeOperationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "exportAvailable": { "type": "boolean" }, "destination": { "type": "object", "properties": { "snowflakeDestinationId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": [ "null", "string" ] }, "warehouse": { "type": [ "null", "string" ] }, "databaseName": { "type": [ "null", "string" ] }, "schemaName": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "principalName": { "type": [ "null", "string" ] }, "authenticationType": { "type": [ "null", "string" ] }, "credentialProvider": { "type": [ "null", "string" ] }, "credentialConfigured": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "rowVersion": { "type": [ "null", "string" ] }, "publicKey": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastResult": { "type": [ "null", "string" ] }, "operationInProgress": { "type": "boolean" }, "runs": { }, "checkpoints": { } } }, "setupSql": { "type": [ "null", "string" ] }, "keyRotationSql": { "type": [ "null", "string" ] }, "ingestionMode": { "type": [ "null", "string" ] }, "schedulingAvailable": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/organization/snowflake/export": { "post": { "tags": [ "TenantSnowflake" ], "operationId": "developerPostV1AppsOrganizationSnowflakeExport", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeOperationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeOperationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "exportAvailable": { "type": "boolean" }, "destination": { "type": "object", "properties": { "snowflakeDestinationId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": [ "null", "string" ] }, "warehouse": { "type": [ "null", "string" ] }, "databaseName": { "type": [ "null", "string" ] }, "schemaName": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "principalName": { "type": [ "null", "string" ] }, "authenticationType": { "type": [ "null", "string" ] }, "credentialProvider": { "type": [ "null", "string" ] }, "credentialConfigured": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "rowVersion": { "type": [ "null", "string" ] }, "publicKey": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastResult": { "type": [ "null", "string" ] }, "operationInProgress": { "type": "boolean" }, "runs": { }, "checkpoints": { } } }, "setupSql": { "type": [ "null", "string" ] }, "keyRotationSql": { "type": [ "null", "string" ] }, "ingestionMode": { "type": [ "null", "string" ] }, "schedulingAvailable": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/organization/snowflake/enabled": { "put": { "tags": [ "TenantSnowflake" ], "operationId": "developerPutV1AppsOrganizationSnowflakeEnabled", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeEnabledRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeEnabledRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantSnowpipeEnabledRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "exportAvailable": { "type": "boolean" }, "destination": { "type": "object", "properties": { "snowflakeDestinationId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": [ "null", "string" ] }, "warehouse": { "type": [ "null", "string" ] }, "databaseName": { "type": [ "null", "string" ] }, "schemaName": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "principalName": { "type": [ "null", "string" ] }, "authenticationType": { "type": [ "null", "string" ] }, "credentialProvider": { "type": [ "null", "string" ] }, "credentialConfigured": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "rowVersion": { "type": [ "null", "string" ] }, "publicKey": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastResult": { "type": [ "null", "string" ] }, "operationInProgress": { "type": "boolean" }, "runs": { }, "checkpoints": { } } }, "setupSql": { "type": [ "null", "string" ] }, "keyRotationSql": { "type": [ "null", "string" ] }, "ingestionMode": { "type": [ "null", "string" ] }, "schedulingAvailable": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/support-lanes": { "get": { "tags": [ "TenantSupportLanes" ], "summary": "Browse this organization's support lanes", "description": "Requires the verified tenant organization owner. Follow nextAfterId while hasMore is true; there is no fixed lane-count cap. Builder page-design access does not confer lane authority.", "operationId": "developerGetV1AppsInboxSupportLanes", "parameters": [ { "name": "afterId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 25 } }, { "name": "query", "in": "query", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } }, { "name": "includeRetired", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLanePage" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantSupportLanes" ], "summary": "Create an organization-owned support lane", "description": "Attaching an existing email/SMS channel enables ticketing. Supply its exact updatedUtc as expectedEmailUpdatedUtc or expectedSmsUpdatedUtc. Omit expectedRevision on create. GoClaw assignment grants no new record, location, AI or action permissions.", "operationId": "developerPostV1AppsInboxSupportLanes", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportLaneSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportLaneSaveRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneReceipt" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/support-lanes/{laneId}": { "get": { "tags": [ "TenantSupportLanes" ], "summary": "Read a support lane and its current configuration revisions", "operationId": "developerGetV1AppsInboxSupportLanesLaneIdGuid", "parameters": [ { "name": "laneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLane" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantSupportLanes" ], "summary": "Replace support lane configuration with revision checks", "description": "Requires expectedRevision from the lane and exact UTC updatedUtc strings for selected channels, preserving all seven fractional digits. Null channel or GoClaw IDs detach those assignments. A 409 requires reload and review; do not blindly retry. Revisions are bigint decimal strings, not JavaScript numbers.", "operationId": "developerPutV1AppsInboxSupportLanesLaneIdGuid", "parameters": [ { "name": "laneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneSaveRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportLaneSaveRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportLaneSaveRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneReceipt" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/support-lanes/options": { "get": { "tags": [ "TenantSupportLanes" ], "summary": "Find this organization's eligible receiving channels or GoClaw users", "description": "Searchable keyset pagination over already-configured email/SMS channels or active GoClaw tenant users. Include laneId while editing to include its attached channels. No provider credentials are returned.", "operationId": "developerGetV1AppsInboxSupportLanesOptions", "parameters": [ { "name": "kind", "in": "query", "required": true, "schema": { "pattern": "^(email|sms|goclaw)$", "type": "string" } }, { "name": "laneId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "afterId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 25 } }, { "name": "query", "in": "query", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneOptionPage" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/support-lanes/{laneId}/retire": { "post": { "tags": [ "TenantSupportLanes" ], "summary": "Retire a lane without deleting tickets or history", "description": "Requires the current expectedRevision and confirmDetachChannels=true. Receiving channels are detached, their independent ticketing settings are preserved, and future inbound activity resumes ordinary routing. The operation is audited.", "operationId": "developerPostV1AppsInboxSupportLanesLaneIdGuidRetire", "parameters": [ { "name": "laneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneRetireRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportLaneRetireRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SupportLaneRetireRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "Service Unavailable", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportLaneReceipt" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/lego-catalog": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/lego-presentation": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxLegoPresentation", "parameters": [ { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "afterPriority", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "afterLastActivityUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "afterInboxItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "items", "pageSize", "hasMore", "totalRecords", "totalIsExact", "nextPriority", "nextLastActivityUtc", "nextInboxItemId" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "required": [ "inboxItemId", "source", "inboxQueueId", "queueName", "assignedToUserId", "assignedDataRoleId", "status", "goClawStatus", "priority", "subject", "previewText", "activityVersion", "newActivityCount", "firstReceivedUtc", "lastActivityUtc", "dueUtc", "snoozedUntilUtc", "aiIntent", "aiCategory", "aiRiskLevel", "aiConfidence", "aiSummary", "isUnread", "lastReadActivityVersion", "ticket" ], "type": "object", "properties": { "inboxItemId": { "type": "string", "format": "uuid" }, "source": { "required": [ "sourceType", "sourceKey", "sourceRecordId", "sourcePrimaryId", "externalSourceKey", "conversationId", "contactRecordId" ], "type": "object", "properties": { "sourceType": { "type": [ "null", "string" ] }, "sourceKey": { "type": [ "null", "string" ] }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "sourcePrimaryId": { "type": [ "null", "string" ], "format": "uuid" }, "externalSourceKey": { "type": [ "null", "string" ] }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" } } }, "inboxQueueId": { "type": [ "null", "string" ], "format": "uuid" }, "queueName": { "type": [ "null", "string" ] }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "goClawStatus": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "subject": { "type": [ "null", "string" ] }, "previewText": { "type": [ "null", "string" ] }, "activityVersion": { "type": "integer", "format": "int64" }, "newActivityCount": { "type": "integer", "format": "int32" }, "firstReceivedUtc": { "type": "string", "format": "date-time" }, "lastActivityUtc": { "type": "string", "format": "date-time" }, "dueUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "aiIntent": { "type": [ "null", "string" ] }, "aiCategory": { "type": [ "null", "string" ] }, "aiRiskLevel": { "type": [ "null", "string" ] }, "aiConfidence": { "type": [ "null", "number" ], "format": "double" }, "aiSummary": { "type": [ "null", "string" ] }, "isUnread": { "type": "boolean" }, "lastReadActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "ticket": { "required": [ "channelConnectionId", "prefix", "number", "openedUtc" ], "type": "object", "properties": { "channelConnectionId": { "type": "string", "format": "uuid" }, "prefix": { "type": [ "null", "string" ] }, "number": { "type": "integer", "format": "int64" }, "openedUtc": { "type": "string", "format": "date-time" }, "key": { "type": [ "null", "string" ] } } } } } }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "nextPriority": { "type": [ "null", "integer" ], "format": "int32" }, "nextLastActivityUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextInboxItemId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/items": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxItems", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "goClawStatus", "in": "query", "schema": { "type": "string" } }, { "name": "inboxQueueId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "assignedToMe", "in": "query", "schema": { "type": "boolean" } }, { "name": "ticketingOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "afterPriority", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "afterLastActivityUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "afterInboxItemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "items", "pageSize", "hasMore", "totalRecords", "totalIsExact", "nextPriority", "nextLastActivityUtc", "nextInboxItemId" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "required": [ "inboxItemId", "source", "inboxQueueId", "queueName", "assignedToUserId", "assignedDataRoleId", "status", "goClawStatus", "priority", "subject", "previewText", "activityVersion", "newActivityCount", "firstReceivedUtc", "lastActivityUtc", "dueUtc", "snoozedUntilUtc", "aiIntent", "aiCategory", "aiRiskLevel", "aiConfidence", "aiSummary", "isUnread", "lastReadActivityVersion", "ticket" ], "type": "object", "properties": { "inboxItemId": { "type": "string", "format": "uuid" }, "source": { "required": [ "sourceType", "sourceKey", "sourceRecordId", "sourcePrimaryId", "externalSourceKey", "conversationId", "contactRecordId" ], "type": "object", "properties": { "sourceType": { "type": [ "null", "string" ] }, "sourceKey": { "type": [ "null", "string" ] }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "sourcePrimaryId": { "type": [ "null", "string" ], "format": "uuid" }, "externalSourceKey": { "type": [ "null", "string" ] }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" } } }, "inboxQueueId": { "type": [ "null", "string" ], "format": "uuid" }, "queueName": { "type": [ "null", "string" ] }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "status": { "type": [ "null", "string" ] }, "goClawStatus": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "subject": { "type": [ "null", "string" ] }, "previewText": { "type": [ "null", "string" ] }, "activityVersion": { "type": "integer", "format": "int64" }, "newActivityCount": { "type": "integer", "format": "int32" }, "firstReceivedUtc": { "type": "string", "format": "date-time" }, "lastActivityUtc": { "type": "string", "format": "date-time" }, "dueUtc": { "type": [ "null", "string" ], "format": "date-time" }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "aiIntent": { "type": [ "null", "string" ] }, "aiCategory": { "type": [ "null", "string" ] }, "aiRiskLevel": { "type": [ "null", "string" ] }, "aiConfidence": { "type": [ "null", "number" ], "format": "double" }, "aiSummary": { "type": [ "null", "string" ] }, "isUnread": { "type": "boolean" }, "lastReadActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "ticket": { "required": [ "channelConnectionId", "prefix", "number", "openedUtc" ], "type": "object", "properties": { "channelConnectionId": { "type": "string", "format": "uuid" }, "prefix": { "type": [ "null", "string" ] }, "number": { "type": "integer", "format": "int64" }, "openedUtc": { "type": "string", "format": "date-time" }, "key": { "type": [ "null", "string" ] } } } } } }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "nextPriority": { "type": [ "null", "integer" ], "format": "int32" }, "nextLastActivityUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextInboxItemId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/email-channels/ticketing": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxEmailChannelsTicketing", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "canManage", "mailboxes" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canManage": { "type": "boolean" }, "mailboxes": { "type": [ "null", "array" ], "items": { "required": [ "channelConnectionId", "displayLabel", "emailAddress", "inboundAddress", "isInboundEnabled", "status", "isTicketingEnabled", "ticketPrefix", "nextTicketNumber" ], "type": "object", "properties": { "channelConnectionId": { "type": "string", "format": "uuid" }, "displayLabel": { "type": [ "null", "string" ] }, "emailAddress": { "type": [ "null", "string" ], "format": "email" }, "inboundAddress": { "type": [ "null", "string" ] }, "isInboundEnabled": { "type": "boolean" }, "status": { "type": [ "null", "string" ] }, "isTicketingEnabled": { "type": "boolean" }, "ticketPrefix": { "type": [ "null", "string" ] }, "nextTicketNumber": { "type": "integer", "format": "int64" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/email-channels/{channelConnectionId}/ticketing": { "put": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerPutV1AppsInboxEmailChannelsChannelConnectionIdGuidTicketing", "parameters": [ { "name": "channelConnectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantEmailTicketingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantEmailTicketingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantEmailTicketingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "channelConnectionId", "displayLabel", "emailAddress", "inboundAddress", "isInboundEnabled", "status", "isTicketingEnabled", "ticketPrefix", "nextTicketNumber" ], "type": "object", "properties": { "channelConnectionId": { "type": "string", "format": "uuid" }, "displayLabel": { "type": [ "null", "string" ] }, "emailAddress": { "type": [ "null", "string" ], "format": "email" }, "inboundAddress": { "type": [ "null", "string" ] }, "isInboundEnabled": { "type": "boolean" }, "status": { "type": [ "null", "string" ] }, "isTicketingEnabled": { "type": "boolean" }, "ticketPrefix": { "type": [ "null", "string" ] }, "nextTicketNumber": { "type": "integer", "format": "int64" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/items/{inboxItemId}": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxItemsInboxItemIdGuid", "parameters": [ { "name": "inboxItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "inboxItemId", "appAccountId", "recordId", "source", "document" ], "type": "object", "properties": { "inboxItemId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "source": { "required": [ "sourceType", "sourceKey", "sourceRecordId", "sourcePrimaryId", "externalSourceKey", "conversationId", "contactRecordId" ], "type": "object", "properties": { "sourceType": { "type": [ "null", "string" ] }, "sourceKey": { "type": [ "null", "string" ] }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "sourcePrimaryId": { "type": [ "null", "string" ], "format": "uuid" }, "externalSourceKey": { "type": [ "null", "string" ] }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" } } }, "document": { } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/badge": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxBadge", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "unreadTotal", "readyForApproval", "needsHuman", "goClawWorking", "assignedToMeOpen", "failedSends", "sources", "asOfUtc" ], "type": "object", "properties": { "unreadTotal": { "type": "integer", "format": "int32" }, "readyForApproval": { "type": "integer", "format": "int32" }, "needsHuman": { "type": "integer", "format": "int32" }, "goClawWorking": { "type": "integer", "format": "int32" }, "assignedToMeOpen": { "type": "integer", "format": "int32" }, "failedSends": { "type": "integer", "format": "int32" }, "sources": { "type": [ "null", "array" ], "items": { "required": [ "sourceType", "itemCount" ], "type": "object", "properties": { "sourceType": { "type": [ "null", "string" ] }, "itemCount": { "type": "integer", "format": "int32" } } } }, "asOfUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/notifications": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxNotifications", "parameters": [ { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 8 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "inboxItemId", "source", "subject", "bodyText", "notificationType", "priority", "createdUtc", "isRead", "sourceTableName" ], "type": "object", "properties": { "inboxItemId": { "type": "string", "format": "uuid" }, "source": { "required": [ "sourceType", "sourceKey", "sourceRecordId", "sourcePrimaryId", "externalSourceKey", "conversationId", "contactRecordId" ], "type": "object", "properties": { "sourceType": { "type": [ "null", "string" ] }, "sourceKey": { "type": [ "null", "string" ] }, "sourceRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "sourcePrimaryId": { "type": [ "null", "string" ], "format": "uuid" }, "externalSourceKey": { "type": [ "null", "string" ] }, "conversationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" } } }, "subject": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "notificationType": { "type": [ "null", "string" ] }, "priority": { "type": "integer", "format": "int32" }, "createdUtc": { "type": "string", "format": "date-time" }, "isRead": { "type": "boolean" }, "sourceTableName": { "type": [ "null", "string" ] } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/delivery/debug": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxDeliveryDebug", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "stuckMinutes", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 15 } }, { "name": "top", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "items", "counts", "asOfUtc" ], "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "required": [ "outboundMessageId", "conversationId", "channelKey", "subject", "toAddress", "deliveryStatus", "isStuck", "canRetry", "retryAttempts", "maxRetries", "failureCode", "failureType", "scheduledSendUtc", "leaseUntilUtc", "sentUtc", "createdUtc" ], "type": "object", "properties": { "outboundMessageId": { "type": "string", "format": "uuid" }, "conversationId": { "type": "string", "format": "uuid" }, "channelKey": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "toAddress": { "type": [ "null", "string" ] }, "deliveryStatus": { "type": [ "null", "string" ] }, "isStuck": { "type": "boolean" }, "canRetry": { "type": "boolean" }, "retryAttempts": { "type": "integer", "format": "int32" }, "maxRetries": { "type": "integer", "format": "int32" }, "failureCode": { "type": [ "null", "string" ] }, "failureType": { "type": [ "null", "string" ] }, "scheduledSendUtc": { "type": [ "null", "string" ], "format": "date-time" }, "leaseUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "sentUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" } } } }, "counts": { "required": [ "queued", "sending", "stuck", "failed", "sent24h" ], "type": "object", "properties": { "queued": { "type": "integer", "format": "int32" }, "sending": { "type": "integer", "format": "int32" }, "stuck": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "sent24h": { "type": "integer", "format": "int32" } } }, "asOfUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/delivery/{outboundMessageId}/retry": { "post": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerPostV1AppsInboxDeliveryOutboundMessageIdGuidRetry", "parameters": [ { "name": "outboundMessageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantDeliveryRetryReceipt" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantDeliveryRetryReceipt" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantDeliveryRetryReceipt" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/items/{inboxItemId}/human-state": { "put": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerPutV1AppsInboxItemsInboxItemIdGuidHumanState", "parameters": [ { "name": "inboxItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantInboxHumanStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantInboxHumanStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantInboxHumanStateRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/badge/indicator": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxBadgeIndicator", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "attentionDisplayCount", "attentionIsCapped", "asOfUtc" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "attentionDisplayCount": { "maximum": 99, "minimum": 0, "type": "integer", "format": "int32" }, "attentionIsCapped": { "type": "boolean" }, "asOfUtc": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/channels/ticketing": { "get": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerGetV1AppsInboxChannelsTicketing", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboxChannelTicketingSettings" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/channels/{channelConnectionId}/ticketing": { "put": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerPutV1AppsInboxChannelsChannelConnectionIdGuidTicketing", "parameters": [ { "name": "channelConnectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantChannelTicketingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantChannelTicketingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantChannelTicketingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboxChannelTicketingSetting" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/inbox/items/{inboxItemId}/reply": { "post": { "tags": [ "TenantUniversalInbox" ], "operationId": "developerPostV1AppsInboxItemsInboxItemIdGuidReply", "parameters": [ { "name": "inboxItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantInboxReplyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantInboxReplyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantInboxReplyRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/web-links/lego/catalog": { "get": { "tags": [ "TenantWebLinks" ], "operationId": "developerGetV1AppsModulesWebLinksLegoCatalog", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/web-links/lookups/{lookupId}": { "get": { "tags": [ "TenantWebLinks" ], "operationId": "developerGetV1AppsModulesWebLinksLookupsLookupIdGuid", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/web-links": { "get": { "tags": [ "TenantWebLinks" ], "operationId": "developerGetV1AppsModulesWebLinks", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "webLinkId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantWebLinks" ], "operationId": "developerPostV1AppsModulesWebLinks", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLinkWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebLinkWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebLinkWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "webLinkId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/web-links/{recordId}": { "get": { "tags": [ "TenantWebLinks" ], "operationId": "developerGetV1AppsModulesWebLinksRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "createdByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdByDisplayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "canEdit": { "type": "boolean" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { }, "clear": { "type": "boolean" } } } }, "webLinkId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantWebLinks" ], "operationId": "developerPutV1AppsModulesWebLinksRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLinkWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebLinkWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebLinkWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "webLinkId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantWebLinks" ], "operationId": "developerDeleteV1AppsModulesWebLinksRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectedUpdatedUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/web-links/{recordId}/favorite": { "put": { "tags": [ "TenantWebLinks" ], "operationId": "developerPutV1AppsModulesWebLinksRecordIdGuidFavorite", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLinkFavoriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebLinkFavoriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebLinkFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "webLinkId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/schema": { "get": { "tags": [ "TenantWorkOrders" ], "operationId": "developerGetV1AppsModulesWorkOrdersSchema", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "catalogId": { "type": "string", "format": "uuid" }, "catalogVersion": { "type": "integer", "format": "int32" }, "resources": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "resourceId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "fieldCatalogId": { "type": "string", "format": "uuid" }, "bindingIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } } }, "fieldCatalogs": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldCatalogId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "fields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "required": { "type": "boolean" }, "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "maximumLength": { "type": [ "null", "integer" ], "format": "int32" }, "minimum": { "type": [ "null", "number" ], "format": "double" }, "maximum": { "type": [ "null", "number" ], "format": "double" }, "choiceIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "lookupId": { "type": [ "null", "string" ], "format": "uuid" } } } } } } }, "bindings": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "bindingId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "presentationKind": { "type": [ "null", "string" ] }, "defaultPageSize": { "type": "integer", "format": "int32" }, "maximumPageSize": { "type": "integer", "format": "int32" }, "filterFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "sortFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } } }, "actions": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "kind": { "type": [ "null", "string" ] }, "inputFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "requiresRecordId": { "type": "boolean" }, "requiresExpectedRevision": { "type": "boolean" }, "requiresConfirmation": { "type": "boolean" }, "result": { "type": "object", "properties": { "returnsRevision": { "type": "boolean" }, "canConflict": { "type": "boolean" }, "refreshBindingId": { "type": [ "null", "string" ], "format": "uuid" } } } } } }, "components": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "componentId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "rendererKey": { "type": [ "null", "string" ] }, "trustLevel": { "type": [ "null", "string" ] }, "resourceId": { "type": [ "null", "string" ], "format": "uuid" }, "bindingId": { "type": [ "null", "string" ], "format": "uuid" }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "fieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "defaultProps": { } } } }, "vocabularies": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "vocabularyId": { "type": "string", "format": "uuid" }, "fieldId": { "type": "string", "format": "uuid" }, "allowsCustomValue": { "type": "boolean" }, "choices": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "choiceId": { "type": "string", "format": "uuid" }, "value": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] } } } } } } }, "lookups": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "lookupId": { "type": "string", "format": "uuid" }, "kind": { "type": [ "null", "string" ] }, "maximumPageSize": { "type": "integer", "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/lookups/{lookupId}": { "get": { "tags": [ "TenantWorkOrders" ], "operationId": "developerGetV1AppsModulesWorkOrdersLookupsLookupIdGuid", "parameters": [ { "name": "lookupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "lookupId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "optionId": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/{recordId}/status-transitions": { "get": { "tags": [ "TenantWorkOrders" ], "operationId": "developerGetV1AppsModulesWorkOrdersRecordIdGuidStatusTransitions", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "currentChoiceId": { "type": "string", "format": "uuid" }, "currentValue": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "choiceId": { "type": "string", "format": "uuid" }, "value": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders": { "get": { "tags": [ "TenantWorkOrders" ], "operationId": "developerGetV1AppsModulesWorkOrders", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "canCreate": { "type": "boolean" }, "canBill": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "workOrderId": { "type": "string", "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "customerRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "customerName": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": [ "null", "string" ] }, "scheduledStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "scheduledEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "assignmentCount": { "type": "integer", "format": "int32" } } } } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "post": { "tags": [ "TenantWorkOrders" ], "operationId": "developerPostV1AppsModulesWorkOrders", "parameters": [ { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkOrderWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkOrderWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "workOrderId": { "type": [ "null", "string" ], "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignmentRole": { "type": [ "null", "string" ] }, "isPrimary": { "type": [ "null", "boolean" ] }, "isActive": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/{recordId}": { "get": { "tags": [ "TenantWorkOrders" ], "operationId": "developerGetV1AppsModulesWorkOrdersRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "relationCount": { "type": "integer", "format": "int32" }, "assignments": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "workOrderAssignmentId": { "type": "string", "format": "uuid" }, "assignedUserId": { "type": "string", "format": "uuid" }, "assignedUserName": { "type": [ "null", "string" ] }, "assignmentRole": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" }, "assignedUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { } } } }, "recordId": { "type": "string", "format": "uuid" }, "workOrderId": { "type": "string", "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "customerRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "customerName": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "priority": { "type": [ "null", "string" ] }, "scheduledStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "scheduledEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "assignmentCount": { "type": "integer", "format": "int32" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "put": { "tags": [ "TenantWorkOrders" ], "operationId": "developerPutV1AppsModulesWorkOrdersRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkOrderWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkOrderWriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "workOrderId": { "type": [ "null", "string" ], "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignmentRole": { "type": [ "null", "string" ] }, "isPrimary": { "type": [ "null", "boolean" ] }, "isActive": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] }, "delete": { "tags": [ "TenantWorkOrders" ], "operationId": "developerDeleteV1AppsModulesWorkOrdersRecordIdGuid", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/{recordId}/status": { "put": { "tags": [ "TenantWorkOrders" ], "operationId": "developerPutV1AppsModulesWorkOrdersRecordIdGuidStatus", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkOrderStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkOrderStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "workOrderId": { "type": [ "null", "string" ], "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignmentRole": { "type": [ "null", "string" ] }, "isPrimary": { "type": [ "null", "boolean" ] }, "isActive": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } }, "/v1/apps/{saasAppId}/modules/work-orders/{recordId}/assignment": { "put": { "tags": [ "TenantWorkOrders" ], "operationId": "developerPutV1AppsModulesWorkOrdersRecordIdGuidAssignment", "parameters": [ { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "saasAppId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WorkOrderAssignmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "workOrderId": { "type": [ "null", "string" ], "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignmentRole": { "type": [ "null", "string" ] }, "isPrimary": { "type": [ "null", "boolean" ] }, "isActive": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } } } } }, "401": { "description": "Authentication is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "The authenticated credential is not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "429": { "description": "The operation rate limit was exceeded.", "headers": { "Retry-After": { "description": "Whole seconds the client should wait before retrying the request.", "required": true, "schema": { "minimum": 1, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "503": { "description": "A required dependency is unavailable. Retry timing is provided only for explicitly retryable failures.", "headers": { "Retry-After": { "description": "Present only for explicitly retryable dependency failures. Wait at least five seconds before a manual read retry. This is not proof a write rolled back: check current state before resubmitting a mutation; never automatically replay it.", "schema": { "maximum": 5, "minimum": 5, "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "400": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "security": [ { "LiveAppCredential": [ ] }, { "DelegatedUserCredential": [ ] } ] } } }, "components": { "schemas": { "ActiveWorkplaceActivityRequest": { "type": "object", "properties": { "eventType": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "eventData": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "isMeaningfulActivity": { "type": "boolean" } } }, "ActiveWorkplaceCreateRequest": { "type": "object", "properties": { "rootRecordId": { "type": "string", "format": "uuid" }, "displayName": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "priority": { "type": "integer", "format": "int32" }, "graphScope": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "staleAfterMinutes": { "type": "integer", "format": "int32" }, "warningBeforeStaleMinutes": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CustomFieldValueWrite" } } } }, "ActiveWorkplaceParticipantRequest": { "type": "object", "properties": { "participantType": { "type": [ "null", "string" ] }, "participantId": { "type": "string", "format": "uuid" }, "roleName": { "type": [ "null", "string" ] }, "responsibilityText": { "type": [ "null", "string" ] }, "isWatcher": { "type": "boolean" }, "canAct": { "type": "boolean" }, "eventSubscriptions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "allowedActions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "approvalPolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "escalationPolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] } } }, "ActiveWorkplaceStatusRequest": { "type": "object", "properties": { "status": { "enum": [ "Active", "Waiting", "AtRisk", "Stale", "Dormant", "Resolved" ], "type": "string" }, "waitingUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "waitingReason": { "type": [ "null", "string" ] }, "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ActiveWorkplaceUpdateRequest": { "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "ownerUserId": { "type": "string", "format": "uuid" }, "priority": { "type": "integer", "format": "int32" }, "graphScope": { "$ref": "#/components/schemas/JsonElement" }, "staleAfterMinutes": { "type": "integer", "format": "int32" }, "warningBeforeStaleMinutes": { "type": "integer", "format": "int32" }, "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CustomFieldValueWrite" } } } }, "AiApiIngestReceipt": { "type": "object", "properties": { "sourceId": { "type": "integer", "format": "int64" }, "sourceHash": { "type": [ "null", "string" ] }, "citation": { "$ref": "#/components/schemas/AiSourceCitation" }, "scheduling": { "$ref": "#/components/schemas/AiSourceChangeScheduleReceipt" } } }, "AiApiSearchCandidate": { "type": "object", "properties": { "chunkId": { "type": "integer", "format": "int64" }, "sourceId": { "type": "integer", "format": "int64" }, "sourceName": { "type": [ "null", "string" ] }, "sourceType": { "type": [ "null", "string" ] }, "chunkIndex": { "type": "integer", "format": "int32" }, "excerpt": { "type": [ "null", "string" ] }, "isExcerptTruncated": { "type": "boolean" }, "tokenCount": { "type": "integer", "format": "int32" }, "fastDistance": { "type": [ "null", "number" ], "format": "double" }, "distance": { "type": "number", "format": "double" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "citation": { "$ref": "#/components/schemas/AiCandidateCitation" } } }, "AiApiSearchResult": { "type": "object", "properties": { "mode": { "type": [ "null", "string" ] }, "modelKey": { "type": [ "null", "string" ] }, "dimensions": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int32" } }, "candidates": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AiApiSearchCandidate" } } } }, "AiApiStatus": { "type": "object", "properties": { "saasAppId": { "type": "string", "format": "uuid" }, "canAiReadRecords": { "type": "boolean" }, "isAccountOwner": { "type": "boolean" }, "modelKey": { "type": [ "null", "string" ] }, "modelVersion": { "type": [ "null", "string" ] }, "supportedDimensions": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int32" } } } }, "AiCandidateCitation": { "type": "object", "properties": { "sourceId": { "type": "integer", "format": "int64" }, "chunkId": { "type": "integer", "format": "int64" }, "sourceRecordId": { "type": "string", "format": "uuid" }, "sourceModuleId": { "type": "string", "format": "uuid" }, "sourceTableName": { "type": [ "null", "string" ] }, "sourcePrimaryId": { "type": "string", "format": "uuid" }, "pageNumber": { "type": [ "null", "integer" ], "format": "int32" }, "documentElementId": { "type": [ "null", "integer" ], "format": "int64" }, "documentElementType": { "type": [ "null", "string" ] }, "visualReferences": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AiCandidateVisualReference" } }, "knowledge": { "$ref": "#/components/schemas/AiKnowledgeCitation" }, "stableKey": { "type": [ "null", "string" ] } } }, "AiCandidateVisualReference": { "type": "object", "properties": { "visualId": { "type": "integer", "format": "int64" }, "pageNumber": { "type": "integer", "format": "int32" }, "storageKey": { "type": [ "null", "string" ] } } }, "AiInsightStateRequest": { "type": "object", "properties": { "markViewed": { "type": [ "null", "boolean" ] }, "isPinned": { "type": [ "null", "boolean" ] }, "isHidden": { "type": [ "null", "boolean" ] }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "clearSnooze": { "type": "boolean" } } }, "AiKnowledgeCitation": { "type": "object", "properties": { "knowledgeArticleId": { "type": "string", "format": "uuid" }, "knowledgeRevisionId": { "type": "string", "format": "uuid" }, "revisionNumber": { "type": "integer", "format": "int32" }, "knowledgeType": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "publishedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastReviewedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "nextReviewUtc": { "type": [ "null", "string" ], "format": "date-time" }, "sourceUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "AiRebuildReceipt": { "type": "object", "properties": { "jobId": { "type": "integer", "format": "int64" }, "wasCreated": { "type": "boolean" } } }, "AiRebuildStatus": { "type": "object", "properties": { "jobId": { "type": "integer", "format": "int64" }, "status": { "type": [ "null", "string" ] }, "targetDimension": { "type": "integer", "format": "int32" }, "itemsTotal": { "type": "integer", "format": "int32" }, "itemsCompleted": { "type": "integer", "format": "int32" }, "itemsFailed": { "type": "integer", "format": "int32" }, "itemsRemaining": { "type": "integer", "format": "int32" } } }, "AiSourceChangeScheduleReceipt": { "type": "object", "properties": { "detectedCount": { "type": "integer", "format": "int32" }, "claimedCount": { "type": "integer", "format": "int32" }, "queuedCount": { "type": "integer", "format": "int32" }, "alreadyScheduledCount": { "type": "integer", "format": "int32" }, "newCount": { "type": "integer", "format": "int32" }, "changedCount": { "type": "integer", "format": "int32" }, "deletedCount": { "type": "integer", "format": "int32" } } }, "AiSourceCitation": { "type": "object", "properties": { "sourceId": { "type": "integer", "format": "int64" }, "recordId": { "type": "string", "format": "uuid" }, "sourceModuleId": { "type": "string", "format": "uuid" }, "sourceTableName": { "type": [ "null", "string" ] }, "sourcePrimaryId": { "type": "string", "format": "uuid" }, "stableKey": { "type": [ "null", "string" ] } } }, "ApiErrorResponse": { "required": [ "contractVersion", "code", "error", "correlationId" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "code": { "minLength": 1, "type": "string" }, "error": { "minLength": 1, "type": "string" }, "correlationId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "ApprovalQueueAction": { "required": [ "aiActionSuggestionId", "actionKey", "actionName", "confidenceScore", "suggestedInputJson" ], "type": "object", "properties": { "aiActionSuggestionId": { "minLength": 1, "type": "string", "format": "uuid" }, "actionKey": { "minLength": 1, "type": "string" }, "actionName": { "minLength": 1, "type": "string" }, "confidenceScore": { "type": "number", "format": "double" }, "suggestedInputJson": { "minLength": 1, "type": "string" } } }, "ApprovalQueueItem": { "required": [ "suggestionBatchId", "inboxItemId", "batchStatus", "summary", "intent", "riskLevel", "overallConfidence", "basedOnActivityVersion", "preparedUtc", "activityVersion", "sourceType", "subject", "previewText", "priority", "lastActivityUtc", "isStale", "draftResponseJson" ], "type": "object", "properties": { "suggestionBatchId": { "minLength": 1, "type": "string", "format": "uuid" }, "inboxItemId": { "minLength": 1, "type": "string", "format": "uuid" }, "batchStatus": { "minLength": 1, "type": "string" }, "summary": { "minLength": 1, "type": "string" }, "intent": { "minLength": 1, "type": "string" }, "riskLevel": { "minLength": 1, "type": "string" }, "overallConfidence": { "type": "number", "format": "double" }, "basedOnActivityVersion": { "type": "integer", "format": "int64" }, "preparedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "activityVersion": { "type": "integer", "format": "int64" }, "sourceType": { "minLength": 1, "type": "string" }, "subject": { "minLength": 1, "type": "string" }, "previewText": { "minLength": 1, "type": "string" }, "priority": { "type": "integer", "format": "uint8" }, "lastActivityUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "isStale": { "type": "boolean" }, "draftResponseJson": { "minLength": 1, "type": "string" }, "suggestedActions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ApprovalQueueAction" } } } }, "ApprovedActionExecution": { "required": [ "aiActionExecutionId", "aiActionSuggestionId", "actionKey" ], "type": "object", "properties": { "aiActionExecutionId": { "minLength": 1, "type": "string", "format": "uuid" }, "aiActionSuggestionId": { "minLength": 1, "type": "string", "format": "uuid" }, "actionKey": { "minLength": 1, "type": "string" } } }, "CalendarDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "CalendarFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "CalendarRemovalResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "CalendarWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "title": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "description": { "type": [ "null", "string" ] }, "isAllDay": { "type": "boolean" }, "locationText": { "type": [ "null", "string" ] }, "colorKey": { "type": [ "null", "string" ] }, "recurrenceRule": { "type": [ "null", "string" ] }, "recurrenceEnd": { "type": [ "null", "string" ], "format": "date-time" }, "reminderMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "isPrivate": { "type": "boolean" }, "videoConferenceUrl": { "type": [ "null", "string" ] }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CalendarDynamicFieldInput" } } } }, "CaseFlowTransitionRequest": { "type": "object", "properties": { "expectedStage": { "type": [ "null", "string" ] }, "targetStage": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ChatMessageUpdateRequest": { "type": "object", "properties": { "messageText": { "type": [ "null", "string" ] }, "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ChatMessageWriteRequest": { "type": "object", "properties": { "messageText": { "type": [ "null", "string" ] }, "parentChatMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "attachedFileId": { "type": [ "null", "string" ], "format": "uuid" }, "mentionedUserIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "ChatReactionRequest": { "type": "object", "properties": { "reaction": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" } } }, "ChatRoomDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "ChatRoomFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "ChatRoomMemberWriteRequest": { "type": "object", "properties": { "isMember": { "type": "boolean" }, "isAdmin": { "type": "boolean" }, "isMuted": { "type": "boolean" } } }, "ChatRoomWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "roomName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "roomType": { "type": "integer", "format": "uint8" }, "isArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ChatRoomDynamicFieldInput" } } } }, "ChecklistItemUpdateRequest": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "format": "int64" }, "status": { "enum": [ "NotStarted", "Completed", "Failed", "NotApplicable" ], "type": "string" }, "responseText": { "type": [ "null", "string" ] } } }, "ChecklistMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "checklistTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "approvalWorkflowDefinitionId": { "type": [ "null", "string" ], "format": "uuid" }, "itemCount": { "type": [ "null", "integer" ], "format": "int32" }, "checklistRunId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistRunItemId": { "type": [ "null", "string" ], "format": "uuid" }, "checklistItemEvidenceId": { "type": [ "null", "string" ], "format": "uuid" }, "fileRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "proofKind": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "integer" ], "format": "int64" }, "itemRevision": { "type": [ "null", "integer" ], "format": "int64" }, "runRevision": { "type": [ "null", "integer" ], "format": "int64" }, "workflowRunId": { "type": [ "null", "string" ], "format": "uuid" }, "workflowRunStepId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxItemId": { "type": [ "null", "string" ], "format": "uuid" }, "inboxActivityVersion": { "type": [ "null", "integer" ], "format": "int64" }, "wasReplay": { "type": [ "null", "boolean" ] }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ChecklistProofAttachRequest": { "type": "object", "properties": { "fileRecordId": { "type": "string", "format": "uuid" }, "proofKind": { "enum": [ "Document", "Photo" ], "type": "string" }, "caption": { "type": [ "null", "string" ] } } }, "ChecklistRunStartRequest": { "type": "object", "properties": { "targetRecordId": { "type": "string", "format": "uuid" }, "checklistTemplateId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] } } }, "ChecklistSubmitRequest": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "format": "int64" }, "requestId": { "type": "string", "format": "uuid" } } }, "ChecklistTemplateCreateRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ChecklistTemplateItemWriteRequest" } } } }, "ChecklistTemplateItemWriteRequest": { "type": "object", "properties": { "itemKey": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "instructions": { "type": [ "null", "string" ] }, "responseType": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "evidenceRequirement": { "type": [ "null", "string" ] }, "minimumEvidenceCount": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" } } }, "ChecklistTemplateUpdateRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ChecklistTemplateItemWriteRequest" } } } }, "CompanyNewsDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "CompanyNewsFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "CompanyNewsPublishedRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isPublished": { "type": "boolean" } } }, "CompanyNewsRemovalResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "CompanyNewsWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "title": { "type": [ "null", "string" ] }, "body": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "publishUtc": { "type": [ "null", "string" ], "format": "date-time" }, "expiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isPublished": { "type": "boolean" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyNewsDynamicFieldInput" } } } }, "ContactCreateVisibilityOption": { "type": "object", "properties": { "scope": { "type": [ "null", "string" ] }, "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "label": { "type": [ "null", "string" ] } } }, "ContactCreateVisibilityOptionsResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactCreateVisibilityOption" } } } }, "ContactDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "ContactFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "ContactListResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "browseLimit": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactSummary" } } } }, "ContactMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": [ "null", "string" ], "format": "uuid" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isFavorite": { "type": [ "null", "boolean" ] } } }, "ContactRemovalResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "ContactSummary": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "contactType": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ], "format": "email" }, "phone": { "type": [ "null", "string" ] }, "mobilePhone": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" } } }, "ContactWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "isPersonal": { "type": [ "null", "boolean" ] }, "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactType": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ], "format": "email" }, "phone": { "type": [ "null", "string" ] }, "mobilePhone": { "type": [ "null", "string" ] }, "address1": { "type": [ "null", "string" ] }, "address2": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "stateProvince": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactDynamicFieldInput" } } } }, "ConversationCreateRequest": { "type": "object", "properties": { "subject": { "type": [ "null", "string" ] }, "channelTypeId": { "type": "integer", "format": "int32" }, "channelConnectionId": { "type": [ "null", "string" ], "format": "uuid" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "priority": { "type": "integer", "format": "int32" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ConversationDynamicFieldInput" } } } }, "ConversationDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "ConversationFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "ConversationMessageWriteRequest": { "type": "object", "properties": { "direction": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "bodyHtml": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "toAddress": { "type": [ "null", "string" ] }, "ccAddress": { "type": [ "null", "string" ] }, "scheduledSendUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ConversationRemovalResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "conversationId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "ConversationUpdateRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "subject": { "type": [ "null", "string" ] }, "status": { "enum": [ "Open", "Pending", "Snoozed", "Closed" ], "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "assignedToUserId": { "type": [ "null", "string" ], "format": "uuid" }, "snoozeUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ConversationDynamicFieldInput" } } } }, "CreateDeveloperInvitationRequest": { "required": [ "email", "displayName", "userTypeKey", "locationScopeMode" ], "type": "object", "properties": { "email": { "maxLength": 320, "minLength": 1, "type": "string", "format": "email" }, "displayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "userTypeKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "dataRoleIds": { "maxItems": 100, "minItems": 1, "type": [ "null", "array" ], "items": { "type": "integer", "format": "int32" } }, "locationScopeMode": { "minLength": 1, "enum": [ "all", "selected" ], "type": "string" }, "locationIds": { "maxItems": 100, "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "lifetimeHours": { "maximum": 720, "minimum": 1, "type": "integer", "format": "int32" } } }, "CreateDeveloperTenantAccountRequest": { "required": [ "providerKey", "externalAccountId", "accountName", "primaryEmail", "ownerExternalSubject", "ownerEmail", "ownerDisplayName" ], "type": "object", "properties": { "providerKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "externalAccountId": { "maxLength": 200, "minLength": 1, "type": "string" }, "accountName": { "maxLength": 200, "minLength": 1, "type": "string" }, "primaryEmail": { "maxLength": 320, "minLength": 1, "type": "string", "format": "email" }, "ownerExternalSubject": { "maxLength": 200, "minLength": 1, "type": "string" }, "ownerEmail": { "maxLength": 320, "minLength": 1, "type": "string", "format": "email" }, "ownerDisplayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "dataRoles": { "maxItems": 5, "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantBootstrapRoleRequest" } }, "locations": { "maxItems": 5, "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantBootstrapLocationRequest" } } } }, "CreateDeveloperTenantUserRequest": { "required": [ "providerKey", "externalSubject", "email", "displayName", "userTypeKey", "dataRoleIds", "locationScopeMode" ], "type": "object", "properties": { "providerKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "externalSubject": { "maxLength": 200, "minLength": 1, "type": "string" }, "email": { "maxLength": 320, "minLength": 1, "type": "string", "format": "email" }, "displayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "userTypeKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "dataRoleIds": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" } }, "locationScopeMode": { "minLength": 1, "enum": [ "all", "selected" ], "type": "string" }, "locationIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CustomFieldDefinition": { "required": [ "fieldDefinitionId", "fieldKey", "label", "dataType", "definitionScope", "required", "searchable", "sortable", "sortOrder", "hidden", "updatedUtc", "canManage" ], "type": "object", "properties": { "fieldDefinitionId": { "minLength": 1, "type": "string", "format": "uuid" }, "fieldKey": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "dataType": { "minLength": 1, "type": "string" }, "definitionScope": { "minLength": 1, "type": "string" }, "required": { "type": "boolean" }, "searchable": { "type": "boolean" }, "sortable": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "defaultValue": { "type": [ "null", "string" ] }, "validationRegex": { "type": [ "null", "string" ] }, "minValue": { "type": [ "null", "string" ] }, "maxValue": { "type": [ "null", "string" ] }, "maxLength": { "type": [ "null", "integer" ], "format": "int32" }, "options": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "fieldGroup": { "type": [ "null", "string" ] }, "hidden": { "type": "boolean" }, "updatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "canManage": { "type": "boolean" } } }, "CustomFieldMutation": { "required": [ "contractVersion", "fieldDefinitionId", "fieldKey", "dataType", "updatedUtc" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "fieldDefinitionId": { "minLength": 1, "type": "string", "format": "uuid" }, "fieldKey": { "minLength": 1, "type": "string" }, "dataType": { "minLength": 1, "type": "string" }, "updatedUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "CustomFieldValueWrite": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "DeactivateDeveloperTenantUserRequest": { "required": [ "expectedRevisionUtc" ], "type": "object", "properties": { "expectedRevisionUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "DeliveryDebugCounts": { "required": [ "queued", "sending", "stuck", "failed", "sent24h" ], "type": "object", "properties": { "queued": { "type": "integer", "format": "int32" }, "sending": { "type": "integer", "format": "int32" }, "stuck": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "sent24h": { "type": "integer", "format": "int32" } } }, "DeliveryDebugItem": { "required": [ "outboundMessageId", "conversationId", "channelKey", "subject", "toAddress", "deliveryStatus", "isStuck", "canRetry", "retryAttempts", "maxRetries", "failureCode", "failureType", "scheduledSendUtc", "leaseUntilUtc", "sentUtc", "createdUtc" ], "type": "object", "properties": { "outboundMessageId": { "minLength": 1, "type": "string", "format": "uuid" }, "conversationId": { "minLength": 1, "type": "string", "format": "uuid" }, "channelKey": { "minLength": 1, "type": "string" }, "subject": { "minLength": 1, "type": "string" }, "toAddress": { "minLength": 1, "type": "string" }, "deliveryStatus": { "minLength": 1, "type": "string" }, "isStuck": { "type": "boolean" }, "canRetry": { "type": "boolean" }, "retryAttempts": { "type": "integer", "format": "int32" }, "maxRetries": { "type": "integer", "format": "int32" }, "failureCode": { "minLength": 1, "type": "string" }, "failureType": { "minLength": 1, "type": "string" }, "scheduledSendUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "leaseUntilUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "sentUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "createdUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "DeliveryDebugSummary": { "required": [ "items", "counts", "asOfUtc" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryDebugItem" } }, "counts": { "$ref": "#/components/schemas/DeliveryDebugCounts" }, "asOfUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "DeveloperAiIngestRequest": { "type": "object", "properties": { "schedulerBatchSize": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } } }, "DeveloperAiRebuildRequest": { "required": [ "operation" ], "type": "object", "properties": { "operation": { "minLength": 1, "type": "string" }, "targetDimension": { "type": "integer", "format": "int32" }, "targetSourceId": { "type": [ "null", "integer" ], "format": "int64" }, "reason": { "maxLength": 200, "minLength": 0, "type": [ "null", "string" ] } } }, "DeveloperAiSearchRequest": { "required": [ "query" ], "type": "object", "properties": { "query": { "maxLength": 32768, "minLength": 1, "type": "string" }, "mode": { "enum": [ "standard", "1024", "two-stage", "balanced", "high-resolution", "1998" ], "type": "string" }, "topK": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32" }, "stage1Candidates": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" }, "contextRecordId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DeveloperAuthContextResponse": { "required": [ "saasAppId", "scopes", "correlationId" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "scopes": { "type": "array", "items": { "type": "string" } }, "correlationId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "DeveloperConnectorCapabilityResponse": { "type": "object", "properties": { "key": { "type": [ "null", "string" ] }, "sideEffect": { "type": [ "null", "string" ] }, "requiredScopes": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "DeveloperConnectorRegistryResponse": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "types": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperConnectorTypeResponse" } } } }, "DeveloperConnectorTypeResponse": { "type": "object", "properties": { "key": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "credentialMode": { "type": [ "null", "string" ] }, "capabilities": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperConnectorCapabilityResponse" } } } }, "DeveloperCreateInboundEndpointRequest": { "required": [ "endpointKey", "displayName" ], "type": "object", "properties": { "endpointKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "displayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "targetUserId": { "type": [ "null", "string" ], "format": "uuid" }, "targetTagId": { "type": [ "null", "string" ], "format": "uuid" }, "targetDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "defaultChannelTypeId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "defaultLocationId": { "type": [ "null", "string" ], "format": "uuid" }, "conversationMode": { "maxLength": 10, "minLength": 1, "enum": [ "ReuseOpen", "AlwaysNew" ], "type": "string" } } }, "DeveloperCreateRecordRequest": { "required": [ "title" ], "type": "object", "properties": { "title": { "maxLength": 300, "minLength": 1, "type": "string" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "fields": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] } } }, "DeveloperCustomFieldRequest": { "required": [ "fieldKey", "label", "dataType" ], "type": "object", "properties": { "fieldKey": { "maxLength": 100, "minLength": 2, "type": "string" }, "label": { "maxLength": 200, "minLength": 1, "type": "string" }, "dataType": { "maxLength": 50, "minLength": 1, "type": "string" }, "required": { "type": "boolean" }, "searchable": { "type": "boolean" }, "sortable": { "type": "boolean" }, "sortOrder": { "maximum": 1000000, "minimum": 0, "type": "integer", "format": "int32" }, "defaultValue": { "maxLength": 500, "minLength": 0, "type": [ "null", "string" ] }, "validationRegex": { "maxLength": 500, "minLength": 0, "type": [ "null", "string" ] }, "minValue": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "maxValue": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "maxLength": { "maximum": 1000000, "minimum": 1, "type": [ "null", "integer" ], "format": "int32" }, "options": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "fieldGroup": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "hidden": { "type": "boolean" }, "expectedUpdatedUtc": { "type": [ "null", "string" ] } } }, "DeveloperDatabaseContractPlane": { "type": "object", "properties": { "key": { "type": [ "null", "string" ] }, "contractCount": { "type": "integer", "format": "int32" }, "contractSha256": { "type": [ "null", "string" ] } } }, "DeveloperDatabaseContractSnapshot": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "contractSetSha256": { "type": [ "null", "string" ] }, "contractCount": { "type": "integer", "format": "int32" }, "planes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperDatabaseContractPlane" } }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperDataConnectorOperationRequest": { "required": [ "key" ], "type": "object", "properties": { "key": { "maxLength": 100, "minLength": 1, "type": "string" }, "method": { "maxLength": 10, "minLength": 1, "type": [ "null", "string" ] }, "path": { "maxLength": 500, "minLength": 1, "type": [ "null", "string" ] }, "document": { "maxLength": 65536, "minLength": 1, "type": [ "null", "string" ] }, "operationName": { "maxLength": 100, "minLength": 1, "type": [ "null", "string" ] }, "timeoutSeconds": { "maximum": 120, "minimum": 1, "type": "integer", "format": "int32" } } }, "DeveloperDataConnectorWriteRequest": { "required": [ "connectorKey", "typeKey", "endpoint", "authType", "operations" ], "type": "object", "properties": { "connectorKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "typeKey": { "maxLength": 30, "minLength": 1, "type": "string" }, "secretReference": { "$ref": "#/components/schemas/SecretReference" }, "endpoint": { "maxLength": 500, "minLength": 1, "type": "string" }, "authType": { "maxLength": 30, "minLength": 1, "type": "string" }, "authHeaderName": { "maxLength": 100, "minLength": 1, "type": [ "null", "string" ] }, "operations": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DeveloperDataConnectorOperationRequest" } }, "isActive": { "type": "boolean" } } }, "DeveloperDataRoleMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "appAccountId": { "type": "string", "format": "uuid" }, "dataRoleId": { "type": "integer", "format": "int32" }, "revisionUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperDelegatedTokenResponse": { "type": "object", "properties": { "tokenId": { "type": "string", "format": "uuid" }, "accessToken": { "type": [ "null", "string" ] }, "tokenType": { "type": [ "null", "string" ] }, "expiresUtc": { "type": "string", "format": "date-time" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "scopes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperGoClawSkillAssignmentRequest": { "required": [ "skillVersionId" ], "type": "object", "properties": { "skillVersionId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "DeveloperGoClawSkillAssignmentResponse": { "required": [ "assignmentId", "goClawAgentId", "skillKey", "skillVersionId", "assignedUtc" ], "type": "object", "properties": { "assignmentId": { "minLength": 1, "type": "string", "format": "uuid" }, "goClawAgentId": { "minLength": 1, "type": "string", "format": "uuid" }, "skillKey": { "minLength": 1, "type": "string" }, "skillVersionId": { "minLength": 1, "type": "string", "format": "uuid" }, "assignedUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "DeveloperInstalledServiceCatalogResponse": { "required": [ "contractSetSha256", "services" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "contractSetSha256": { "maxLength": 64, "minLength": 64, "pattern": "^[0-9a-f]{64}$", "type": "string" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperInstalledServiceContractResponse" } } } }, "DeveloperInstalledServiceContractResponse": { "required": [ "serviceKey", "packageVersion", "releaseFingerprintSha256", "healthState", "licenseState", "endpoints" ], "type": "object", "properties": { "serviceKey": { "maxLength": 200, "minLength": 1, "type": "string" }, "packageVersion": { "maxLength": 50, "minLength": 1, "type": "string" }, "releaseFingerprintSha256": { "maxLength": 64, "minLength": 64, "pattern": "^[0-9a-f]{64}$", "type": "string" }, "healthState": { "minLength": 1, "enum": [ "Green", "Yellow", "Red" ], "type": "string" }, "licenseState": { "minLength": 1, "enum": [ "Active", "Suspended", "Revoked" ], "type": "string" }, "isExecutable": { "type": "boolean" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperInstalledServiceEndpointContractResponse" } } } }, "DeveloperInstalledServiceEndpointContractResponse": { "required": [ "endpointKey", "serviceHttpMethod", "serviceRoute", "inputSchema", "outputSchema", "requiredPermissionKey", "executionMode" ], "type": "object", "properties": { "endpointKey": { "maxLength": 200, "minLength": 1, "type": "string" }, "serviceHttpMethod": { "minLength": 1, "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "type": "string" }, "serviceRoute": { "maxLength": 500, "minLength": 1, "type": "string" }, "inputSchema": { "$ref": "#/components/schemas/JsonElement" }, "outputSchema": { "$ref": "#/components/schemas/JsonElement" }, "requiredPermissionKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "timeoutSeconds": { "maximum": 900, "minimum": 1, "type": "integer", "format": "int32" }, "executionMode": { "minLength": 1, "enum": [ "sync", "async" ], "type": "string" }, "isAvailable": { "type": "boolean" }, "canInvoke": { "type": "boolean" } } }, "DeveloperInstalledServiceInvokeRequest": { "type": "object", "properties": { "payload": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "sourceRecordIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "idempotencyKey": { "type": [ "null", "string" ], "format": "uuid" } } }, "DeveloperInstalledServiceTaskCancellationResponse": { "required": [ "taskId", "cancellationState", "revision" ], "type": "object", "properties": { "taskId": { "minLength": 1, "type": "string", "format": "uuid" }, "cancellationState": { "minLength": 1, "pattern": "^(requested|effective|too_late)$", "type": "string" }, "revision": { "maximum": 9223372036854776000, "minimum": 1, "type": "integer", "format": "int64" } } }, "DeveloperInstalledServiceTaskCancelRequest": { "type": "object", "properties": { "expectedRevision": { "maximum": 9223372036854776000, "minimum": 1, "type": [ "null", "integer" ], "format": "int64" } } }, "DeveloperInstalledServiceTaskResponse": { "required": [ "resultType", "taskId", "status", "statusMessage", "createdAt", "lastUpdatedAt", "ttlMs", "pollIntervalMs", "revision", "nativeExecutionType", "nativeExecutionId", "cancellationState", "inputFingerprintSha256" ], "type": "object", "properties": { "resultType": { "minLength": 1, "pattern": "^complete$", "type": "string" }, "taskId": { "minLength": 1, "type": "string", "format": "uuid" }, "status": { "minLength": 1, "pattern": "^(working|completed|failed|cancelled)$", "type": "string" }, "statusMessage": { "minLength": 1, "type": "string" }, "createdAt": { "minLength": 1, "type": "string", "format": "date-time" }, "lastUpdatedAt": { "minLength": 1, "type": "string", "format": "date-time" }, "ttlMs": { "maximum": 9223372036854776000, "minimum": 1, "type": "integer", "format": "int64" }, "pollIntervalMs": { "maximum": 60000, "minimum": 100, "type": "integer", "format": "int32" }, "revision": { "maximum": 9223372036854776000, "minimum": 1, "type": "integer", "format": "int64" }, "nativeExecutionType": { "minLength": 1, "pattern": "^installed-service-invocation$", "type": "string" }, "nativeExecutionId": { "minLength": 1, "type": "string", "format": "uuid" }, "cancellationState": { "minLength": 1, "pattern": "^(none|requested|effective|too_late)$", "type": "string" }, "outcomeCode": { "type": [ "null", "string" ] }, "httpStatus": { "type": [ "null", "integer" ], "format": "int32" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "inputFingerprintSha256": { "maxLength": 64, "minLength": 64, "pattern": "^[0-9A-F]{64}$", "type": "string" } } }, "DeveloperInvitationListResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "invitations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperInvitationSummary" } } } }, "DeveloperInvitationMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "invitationId": { "type": "string", "format": "uuid" }, "email": { "type": [ "null", "string" ], "format": "email" }, "displayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "expiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "revisionUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" }, "acceptanceToken": { "type": [ "null", "string" ] } } }, "DeveloperInvitationRevisionRequest": { "required": [ "expectedRevisionUtc" ], "type": "object", "properties": { "expectedRevisionUtc": { "minLength": 1, "type": "string" }, "lifetimeHours": { "maximum": 720, "minimum": 1, "type": "integer", "format": "int32" } } }, "DeveloperInvitationSummary": { "type": "object", "properties": { "invitationId": { "type": "string", "format": "uuid" }, "email": { "type": [ "null", "string" ], "format": "email" }, "displayName": { "type": [ "null", "string" ] }, "userTypeKey": { "type": [ "null", "string" ] }, "locationScopeMode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "expiresUtc": { "type": "string", "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "revisionUtc": { "type": "string", "format": "date-time" }, "deliveryStatus": { "type": [ "null", "string" ] }, "deliveryCorrelationId": { "type": [ "null", "string" ], "format": "uuid" }, "deliveredUtc": { "type": [ "null", "string" ], "format": "date-time" }, "dataRoles": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantRoleResponse" } }, "locations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantLocationResponse" } } } }, "DeveloperLocationMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "appAccountId": { "type": "string", "format": "uuid" }, "locationId": { "type": "string", "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperLogEntry": { "type": "object", "properties": { "occurredUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "operationId": { "type": [ "null", "string" ], "format": "uuid" }, "parentOperationId": { "type": [ "null", "string" ], "format": "uuid" }, "eventType": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "action": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "route": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "wasSuccessful": { "type": "boolean" }, "severity": { "type": [ "null", "string" ] } } }, "DeveloperLogQueryResult": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "queryCorrelationId": { "type": "string", "format": "uuid" }, "count": { "type": "integer", "format": "int32" }, "logs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperLogEntry" } } } }, "DeveloperMcpProtocolMessage": { "type": "object" }, "DeveloperOAuthAuthorizationRequest": { "required": [ "providerKey", "connectionKey", "displayName", "scopes" ], "type": "object", "properties": { "providerKey": { "maxLength": 50, "minLength": 1, "type": "string" }, "connectionKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "displayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "scopes": { "maxItems": 50, "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "DeveloperOAuthCompletionRequest": { "required": [ "providerKey", "state", "authorizationCode" ], "type": "object", "properties": { "providerKey": { "maxLength": 50, "minLength": 1, "type": "string" }, "state": { "maxLength": 1024, "minLength": 1, "type": "string" }, "authorizationCode": { "maxLength": 8192, "minLength": 1, "type": "string" } } }, "DeveloperOrganizationAdminDataRole": { "type": "object", "properties": { "dataRoleId": { "type": "integer", "format": "int32" }, "roleName": { "type": [ "null", "string" ] }, "canRead": { "type": "boolean" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canExport": { "type": "boolean" }, "canReadRecords": { "type": "boolean" }, "canAiReadRecords": { "type": "boolean" }, "canExportRecords": { "type": "boolean" }, "canBillRecords": { "type": "boolean" }, "canViewTrustRecords": { "type": "boolean" }, "canApproveDisbursementRecords": { "type": "boolean" }, "isActive": { "type": "boolean" }, "revisionUtc": { "type": "string", "format": "date-time" }, "permissionKeys": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "DeveloperOrganizationAdminLocation": { "type": "object", "properties": { "locationId": { "type": "string", "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "locationCode": { "type": [ "null", "string" ] }, "address1": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "stateProvince": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "timeZone": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "managerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "isActive": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "DeveloperOrganizationAdminResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "primaryEmail": { "type": [ "null", "string" ], "format": "email" }, "status": { "type": [ "null", "string" ] }, "updatedUtc": { "type": "string", "format": "date-time" }, "users": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperOrganizationAdminUser" } }, "dataRoles": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperOrganizationAdminDataRole" } }, "locations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperOrganizationAdminLocation" } }, "userTypes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperOrganizationAdminUserType" } }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperOrganizationAdminUser": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "email": { "type": [ "null", "string" ], "format": "email" }, "displayName": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "isAccountOwner": { "type": "boolean" }, "userTypeKey": { "type": [ "null", "string" ] }, "providerKey": { "type": [ "null", "string" ] }, "externalSubject": { "type": [ "null", "string" ] }, "revisionUtc": { "type": "string", "format": "date-time" }, "dataRoles": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantRoleResponse" } }, "locations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantLocationResponse" } } } }, "DeveloperOrganizationAdminUserType": { "type": "object", "properties": { "userTypeKey": { "type": [ "null", "string" ] }, "userTypeName": { "type": [ "null", "string" ] } } }, "DeveloperOrganizationListItem": { "type": "object", "properties": { "appAccountId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "accountType": { "type": [ "null", "string" ] }, "primaryEmail": { "type": [ "null", "string" ], "format": "email" }, "status": { "type": [ "null", "string" ] }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerDisplayName": { "type": [ "null", "string" ] }, "ownerEmail": { "type": [ "null", "string" ], "format": "email" }, "ownerStatus": { "type": [ "null", "string" ] }, "userCount": { "type": "integer", "format": "int64" }, "activeUserCount": { "type": "integer", "format": "int64" }, "dataRoleCount": { "type": "integer", "format": "int64" }, "locationCount": { "type": "integer", "format": "int64" } } }, "DeveloperOrganizationListResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "correlationId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "nextAfterAppAccountId": { "type": [ "null", "string" ], "format": "uuid" }, "organizations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperOrganizationListItem" } } } }, "DeveloperOrganizationMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "updatedUtc": { "type": "string", "format": "date-time" }, "status": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperOutsideFormEndpointUpdateRequest": { "required": [ "endpointKey", "displayName", "submissionMode", "expectedRevision" ], "type": "object", "properties": { "endpointKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "displayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "submissionMode": { "minLength": 1, "enum": [ "ServerSecret", "PublicBrowser" ], "type": "string" }, "allowedOrigin": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "targetDataRoleId": { "maximum": 2147483647, "minimum": 1, "type": [ "null", "integer" ], "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "isActive": { "type": "boolean" }, "expectedRevision": { "maximum": 9223372036854776000, "minimum": 1, "type": "integer", "format": "int64" }, "rotateSecret": { "type": "boolean" } } }, "DeveloperOwnershipTransferResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "appAccountId": { "type": "string", "format": "uuid" }, "previousOwnerUserId": { "type": "string", "format": "uuid" }, "ownerUserId": { "type": "string", "format": "uuid" }, "status": { "enum": [ "Accepted" ], "type": "string" }, "revisionUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperPageDraft": { "required": [ "saasAppId", "pageKey", "pageHistoryId", "pageJson", "metaJson", "pageVersion", "isDraft" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "pageKey": { "minLength": 1, "type": "string" }, "pageHistoryId": { "minLength": 1, "type": "string", "format": "uuid" }, "pageJson": { "$ref": "#/components/schemas/JsonElement" }, "metaJson": { "$ref": "#/components/schemas/JsonElement" }, "pageVersion": { "type": "integer", "format": "int32" }, "isDraft": { "type": "boolean" } } }, "DeveloperPageDraftSave": { "type": "object", "properties": { "saved": { "type": "boolean" }, "pageHistoryId": { "type": [ "null", "string" ], "format": "uuid" }, "blockedByCode": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] }, "validation": { "$ref": "#/components/schemas/JsonElement" } } }, "DeveloperPageDraftSaveRequest": { "type": "object", "properties": { "pageJson": { "$ref": "#/components/schemas/JsonElement" }, "metaJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "changeNote": { "maxLength": 400, "minLength": 0, "type": [ "null", "string" ] }, "expectedPageVersion": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "acknowledgeIdLoss": { "type": "boolean" } } }, "DeveloperPageHistory": { "required": [ "saasAppId", "pageKey", "history" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "pageKey": { "minLength": 1, "type": "string" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperPageHistoryItem" } } } }, "DeveloperPageHistoryItem": { "type": "object", "properties": { "pageHistoryId": { "type": "string", "format": "uuid" }, "pageVersion": { "type": "integer", "format": "int32" }, "changeType": { "type": [ "null", "string" ] }, "changeNote": { "type": [ "null", "string" ] }, "restoredFromHistoryId": { "type": [ "null", "string" ], "format": "uuid" }, "changedByUserId": { "type": [ "null", "string" ], "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" } } }, "DeveloperPageList": { "required": [ "saasAppId", "pages" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperPageSummary" } } } }, "DeveloperPagePublication": { "type": "object", "properties": { "published": { "type": "boolean" }, "pageHistoryId": { "type": "string", "format": "uuid" }, "publishedVersion": { "type": "integer", "format": "int32" } } }, "DeveloperPagePublishRequest": { "type": "object", "properties": { "draftHistoryId": { "type": "string", "format": "uuid" }, "expectedLiveVersion": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "changeNote": { "maxLength": 400, "minLength": 0, "type": [ "null", "string" ] } } }, "DeveloperPageSummary": { "type": "object", "properties": { "saasAppPageId": { "type": "string", "format": "uuid" }, "pageKey": { "type": [ "null", "string" ] }, "pageName": { "type": [ "null", "string" ] }, "pageType": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "layoutKey": { "type": [ "null", "string" ] }, "slug": { "type": [ "null", "string" ] }, "lang": { "type": [ "null", "string" ] }, "pageVersion": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "modifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "hasDraft": { "type": "boolean" } } }, "DeveloperPageValidation": { "required": [ "saasAppId", "pageKey", "pageHistoryId", "pageVersion", "isValid", "errorCount", "warningCount", "removedIdCount", "report" ], "type": "object", "properties": { "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "pageKey": { "minLength": 1, "type": "string" }, "pageHistoryId": { "minLength": 1, "type": "string", "format": "uuid" }, "pageVersion": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" }, "errorCount": { "type": "integer", "format": "int32" }, "warningCount": { "type": "integer", "format": "int32" }, "removedIdCount": { "type": "integer", "format": "int32" }, "report": { "$ref": "#/components/schemas/JsonElement" } } }, "DeveloperPaymentConnectorWriteRequest": { "required": [ "connectorKey", "typeKey", "credentialReference", "webhookSecretReference" ], "type": "object", "properties": { "connectorKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "typeKey": { "maxLength": 50, "minLength": 1, "type": "string" }, "credentialReference": { "$ref": "#/components/schemas/SecretReference" }, "webhookSecretReference": { "$ref": "#/components/schemas/SecretReference" }, "isTestMode": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "DeveloperPresentationPartResponse": { "required": [ "presentationVersion", "kind" ], "type": "object", "properties": { "presentationVersion": { "type": "integer", "format": "int32" }, "kind": { "minLength": 1, "type": "string" } } }, "DeveloperRecordSearchRequest": { "type": "object", "properties": { "query": { "maxLength": 400, "minLength": 0, "type": [ "null", "string" ] }, "status": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "page": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" }, "sort": { "maxLength": 30, "minLength": 0, "type": [ "null", "string" ] } } }, "DeveloperRuntimePageBody": { "required": [ "contractVersion", "runtimeRequestId", "generatedUtc", "components", "page" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "runtimeRequestId": { "minLength": 1, "type": "string", "format": "uuid" }, "generatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/TenantRuntimeComponentContract" } }, "page": { "$ref": "#/components/schemas/TenantRuntimePage" } } }, "DeveloperSkillListResponse": { "required": [ "skills" ], "type": "object", "properties": { "skills": { "maxItems": 512, "type": "array", "items": { "$ref": "#/components/schemas/DeveloperSkillSummaryResponse" } } } }, "DeveloperSkillResourceResponse": { "required": [ "contentBase64", "uri", "mimeType", "digest" ], "type": "object", "properties": { "contentBase64": { "minLength": 1, "type": "string" }, "uri": { "minLength": 1, "type": "string" }, "mimeType": { "minLength": 1, "type": "string" }, "digest": { "minLength": 1, "type": "string" }, "size": { "type": "integer", "format": "int64" } } }, "DeveloperSkillResourceSummaryResponse": { "required": [ "uri", "mimeType", "digest" ], "type": "object", "properties": { "uri": { "minLength": 1, "type": "string" }, "mimeType": { "minLength": 1, "type": "string" }, "digest": { "minLength": 1, "type": "string" }, "size": { "type": "integer", "format": "int64" } } }, "DeveloperSkillResponse": { "required": [ "skillVersionId", "skillKey", "semanticVersion", "uri", "frontmatter", "resolvedScopeType", "resources" ], "type": "object", "properties": { "skillVersionId": { "minLength": 1, "type": "string", "format": "uuid" }, "skillKey": { "minLength": 1, "type": "string" }, "semanticVersion": { "minLength": 1, "type": "string" }, "uri": { "minLength": 1, "type": "string" }, "frontmatter": { "$ref": "#/components/schemas/JsonElement" }, "resolvedScopeType": { "minLength": 1, "type": "string" }, "resolvedScopeRank": { "type": "integer", "format": "int32" }, "declaredDependencies": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "resources": { "maxItems": 512, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DeveloperSkillResourceResponse" } } } }, "DeveloperSkillSummaryResponse": { "required": [ "skillVersionId", "skillKey", "semanticVersion", "uri", "frontmatter", "resolvedScopeType", "resources" ], "type": "object", "properties": { "skillVersionId": { "minLength": 1, "type": "string", "format": "uuid" }, "skillKey": { "minLength": 1, "type": "string" }, "semanticVersion": { "minLength": 1, "type": "string" }, "uri": { "minLength": 1, "type": "string" }, "frontmatter": { "$ref": "#/components/schemas/JsonElement" }, "resolvedScopeType": { "minLength": 1, "type": "string" }, "resolvedScopeRank": { "type": "integer", "format": "int32" }, "declaredDependencies": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "resources": { "maxItems": 512, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DeveloperSkillResourceSummaryResponse" } } } }, "DeveloperTenantAccountResponse": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "ownerUserId": { "type": "string", "format": "uuid" }, "accountName": { "type": [ "null", "string" ] }, "primaryEmail": { "type": [ "null", "string" ], "format": "email" }, "status": { "enum": [ "Active", "Inactive" ], "type": "string" }, "providerKey": { "type": [ "null", "string" ] }, "externalAccountId": { "type": [ "null", "string" ] }, "created": { "type": "boolean" }, "createdUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "dataRoles": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantProvisionMapResponse" } }, "locations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantProvisionMapResponse" } }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DeveloperTenantBootstrapLocationRequest": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "maxLength": 100, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "code": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "address1": { "maxLength": 300, "minLength": 0, "type": [ "null", "string" ] }, "city": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "stateProvince": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "postalCode": { "maxLength": 30, "minLength": 0, "type": [ "null", "string" ] }, "country": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "timeZone": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "phone": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "sortOrder": { "maximum": 100000, "minimum": -100000, "type": "integer", "format": "int32" } } }, "DeveloperTenantBootstrapRoleRequest": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "maxLength": 100, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "canRead": { "type": "boolean" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canExport": { "type": "boolean" }, "canReadRecords": { "type": "boolean" }, "canAiReadRecords": { "type": "boolean" }, "canExportRecords": { "type": "boolean" }, "canBillRecords": { "type": "boolean" }, "canViewTrustRecords": { "type": "boolean" }, "canApproveDisbursementRecords": { "type": "boolean" }, "permissionKeys": { "maxItems": 200, "type": [ "null", "array" ], "items": { "type": "string" } } } }, "DeveloperTenantLocationResponse": { "type": "object", "properties": { "locationId": { "type": "string", "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" } } }, "DeveloperTenantProvisionMapResponse": { "type": "object", "properties": { "key": { "type": [ "null", "string" ] }, "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DeveloperTenantRoleResponse": { "type": "object", "properties": { "dataRoleId": { "type": "integer", "format": "int32" }, "roleName": { "type": [ "null", "string" ] } } }, "DeveloperTenantSecurityCatalogResponse": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "appAccountId": { "type": "string", "format": "uuid" }, "userTypes": { "$ref": "#/components/schemas/JsonElement" }, "dataRoles": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantRoleResponse" } }, "locations": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DeveloperTenantLocationResponse" } } } }, "DeveloperTenantUserCompleteListResponse": { "required": [ "schemaVersion", "appAccountId", "totalCount", "users" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "appAccountId": { "minLength": 1, "type": "string", "format": "uuid" }, "totalCount": { "type": "integer", "description": "Exact number of users in this complete response. This operation has no client paging and no enforced organization-size ceiling; response size grows with user and assignment counts.", "format": "int32" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperTenantUserListItemResponse" } } } }, "DeveloperTenantUserListItemResponse": { "required": [ "appAccountId", "userId", "email", "displayName", "status", "isAccountOwner", "revisionUtc", "dataRoles", "locations", "dataRoleCount", "locationCount", "locationScopeMode" ], "type": "object", "properties": { "appAccountId": { "minLength": 1, "type": "string", "format": "uuid" }, "userId": { "minLength": 1, "type": "string", "format": "uuid" }, "email": { "minLength": 1, "type": "string", "format": "email" }, "displayName": { "minLength": 1, "type": "string" }, "status": { "minLength": 1, "type": "string" }, "isAccountOwner": { "type": "boolean" }, "userTypeKey": { "type": [ "null", "string" ] }, "providerKey": { "type": [ "null", "string" ] }, "externalSubject": { "type": [ "null", "string" ] }, "revisionUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "dataRoles": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperTenantRoleResponse" } }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperTenantLocationResponse" } }, "dataRoleCount": { "type": "integer", "format": "int32" }, "locationCount": { "type": "integer", "description": "Number of selected locations; 0 means the user can access all locations allowed by their DataRoles.", "format": "int32" }, "locationScopeMode": { "minLength": 1, "enum": [ "all", "selected" ], "type": "string" } } }, "DeveloperTenantUserMutationResponse": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "appAccountId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "providerKey": { "type": [ "null", "string" ] }, "externalSubject": { "type": [ "null", "string" ] }, "created": { "type": "boolean" }, "status": { "type": [ "null", "string" ] }, "revisionUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperThemeResponse": { "required": [ "contractVersion", "saasAppId", "themeJson", "cssVariables", "designTokensJson", "version" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "saasAppId": { "minLength": 1, "type": "string", "format": "uuid" }, "themeJson": { "required": [ "schemaVersion", "name", "mode" ], "type": "object", "properties": { "schemaVersion": { "enum": [ 1 ], "type": "integer" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "mode": { "enum": [ "light", "dark", "system" ], "type": "string" } } }, "cssVariables": { "type": "object", "description": "Validated --runtime-* custom properties." }, "designTokensJson": { "type": "object", "properties": { "spacingBase": { "maximum": 24, "minimum": 2, "type": "number" }, "radiusBase": { "maximum": 32, "minimum": 0, "type": "number" } } }, "version": { "type": "integer", "format": "int32" }, "templateThemeId": { "type": [ "null", "string" ], "format": "uuid" }, "modifiedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "DeveloperThemeWriteRequest": { "required": [ "themeJson", "expectedVersion" ], "type": "object", "properties": { "themeJson": { "required": [ "schemaVersion", "name", "mode" ], "type": "object", "properties": { "schemaVersion": { "enum": [ 1 ], "type": "integer" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "mode": { "enum": [ "light", "dark", "system" ], "type": "string" } } }, "cssVariables": { "type": "object", "description": "Up to 128 --runtime-* custom properties using passive color, number, unit, or keyword values." }, "designTokensJson": { "type": "object", "properties": { "spacingBase": { "maximum": 24, "minimum": 2, "type": "number" }, "radiusBase": { "maximum": 32, "minimum": 0, "type": "number" } } }, "templateThemeId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedVersion": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } } }, "DeveloperTokenRevocationResponse": { "type": "object", "properties": { "tokenId": { "type": "string", "format": "uuid" }, "revoked": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "DeveloperUpdateRecordRequest": { "required": [ "expectedUpdatedUtc" ], "type": "object", "properties": { "expectedUpdatedUtc": { "minLength": 1, "type": "string" }, "title": { "maxLength": 300, "minLength": 1, "type": [ "null", "string" ] }, "status": { "maxLength": 50, "minLength": 1, "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "clearLocation": { "type": "boolean" }, "fields": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] } } }, "DeveloperWebhookEventFilterRequest": { "required": [ "eventKey", "eventVersion" ], "type": "object", "properties": { "eventKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "eventVersion": { "maxLength": 20, "minLength": 1, "type": "string" } } }, "DeveloperWebhookSubscriptionRequest": { "required": [ "displayName", "destinationUrl", "events" ], "type": "object", "properties": { "displayName": { "maxLength": 100, "minLength": 1, "type": "string" }, "destinationUrl": { "maxLength": 2048, "minLength": 1, "type": "string" }, "events": { "maxItems": 50, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DeveloperWebhookEventFilterRequest" } }, "isActive": { "type": "boolean" }, "scope": { "maxLength": 20, "minLength": 3, "enum": [ "account", "app" ], "type": "string" } } }, "DirectConversationRequest": { "type": "object", "properties": { "recipientUserId": { "type": "string", "format": "uuid" }, "clientMessageId": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "bodyHtml": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] } } }, "DiscussionBoardWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "boardName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isArchived": { "type": "boolean" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DiscussionDynamicFieldInput" } } } }, "DiscussionDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "DiscussionFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "DiscussionPostUpdateRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "postBody": { "type": [ "null", "string" ] } } }, "DiscussionPostWriteRequest": { "type": "object", "properties": { "postBody": { "type": [ "null", "string" ] }, "parentDiscussionPostId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DiscussionTopicCreateRequest": { "type": "object", "properties": { "topicTitle": { "type": [ "null", "string" ] }, "initialPostBody": { "type": [ "null", "string" ] } } }, "DiscussionTopicUpdateRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "topicTitle": { "type": [ "null", "string" ] }, "isPinned": { "type": "boolean" }, "isLocked": { "type": "boolean" } } }, "DynamicModuleFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "DynamicModuleFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "DynamicModuleWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "clearLocation": { "type": "boolean" }, "fields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DynamicModuleFieldInput" } } } }, "ExchangeDeveloperUserTokenRequest": { "required": [ "providerKey", "externalAccountId", "externalSubject" ], "type": "object", "properties": { "providerKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "externalAccountId": { "maxLength": 200, "minLength": 1, "type": "string" }, "externalSubject": { "maxLength": 200, "minLength": 1, "type": "string" }, "scopes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "lifetimeMinutes": { "maximum": 15, "minimum": 2, "type": "integer", "format": "int32" } } }, "FavoriteLegoPresentation": { "type": "object", "properties": { "presentationVersion": { "type": "integer", "format": "int32" }, "kind": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "columns": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FavoriteLegoPresentationColumn" } }, "rows": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FavoriteLegoPresentationRow" } }, "actions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoPresentationAction" } }, "page": { "$ref": "#/components/schemas/FavoriteLegoPresentationPage" } } }, "FavoriteLegoPresentationColumn": { "type": "object", "properties": { "key": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "align": { "type": [ "null", "string" ] } } }, "FavoriteLegoPresentationPage": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" } } }, "FavoriteLegoPresentationRow": { "type": "object", "properties": { "id": { "type": [ "null", "string" ] }, "recordId": { "type": "string", "format": "uuid" }, "cells": { "type": [ "null", "object" ] }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "revision": { "type": [ "null", "string" ] } } }, "FavoritePreferenceRequest": { "type": "object", "properties": { "isPinned": { "type": "boolean" }, "trackChanges": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" } } }, "FavoriteSetRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "FileAttachmentRequest": { "type": "object", "properties": { "sourceRecordId": { "type": "string", "format": "uuid" }, "sourceModuleKey": { "type": [ "null", "string" ] } } }, "FileDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "FileFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "FileRemovalResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "retentionUntilUtc": { "type": "string", "format": "date-time" }, "cleanupJobsQueued": { "type": "integer", "format": "int32" }, "correlationId": { "type": "string", "format": "uuid" } } }, "FileWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "fileName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "description": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FileDynamicFieldInput" } } } }, "GatewayMetadataResponse": { "required": [ "correlationId" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "apiVersion": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "correlationId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "GlobalSearchFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "GlobalSearchItem": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "recordStatus": { "type": [ "null", "string" ] }, "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "canEdit": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "matchKind": { "type": [ "null", "string" ] }, "matchRank": { "type": "integer", "format": "int32" }, "relationCount": { "type": "integer", "format": "int32" }, "activityCount": { "type": "integer", "format": "int32" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "matchedFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GlobalSearchMatchedField" } } } }, "GlobalSearchMatchedField": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "fieldLabel": { "type": [ "null", "string" ] }, "dataType": { "type": [ "null", "string" ] }, "matchedValue": { "type": [ "null", "string" ] } } }, "GlobalSearchModuleSummary": { "type": "object", "properties": { "moduleKey": { "type": [ "null", "string" ] }, "moduleName": { "type": [ "null", "string" ] } } }, "GlobalSearchResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "browseLimit": { "type": "integer", "format": "int32" }, "query": { "type": [ "null", "string" ] }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "hasMore": { "type": "boolean" }, "modules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GlobalSearchModuleSummary" } }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GlobalSearchItem" } } } }, "IFormFile": { "type": "string", "format": "binary" }, "InboxBadgeIndicator": { "required": [ "attentionDisplayCount", "attentionIsCapped", "asOfUtc" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "attentionDisplayCount": { "maximum": 99, "minimum": 0, "type": "integer", "format": "int32" }, "attentionIsCapped": { "type": "boolean" }, "asOfUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "InboxBadgeSourceCount": { "required": [ "sourceType", "itemCount" ], "type": "object", "properties": { "sourceType": { "minLength": 1, "type": "string" }, "itemCount": { "type": "integer", "format": "int32" } } }, "InboxBadgeSummary": { "required": [ "unreadTotal", "readyForApproval", "needsHuman", "goClawWorking", "assignedToMeOpen", "failedSends", "sources", "asOfUtc" ], "type": "object", "properties": { "unreadTotal": { "type": "integer", "format": "int32" }, "readyForApproval": { "type": "integer", "format": "int32" }, "needsHuman": { "type": "integer", "format": "int32" }, "goClawWorking": { "type": "integer", "format": "int32" }, "assignedToMeOpen": { "type": "integer", "format": "int32" }, "failedSends": { "type": "integer", "format": "int32" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/InboxBadgeSourceCount" } }, "asOfUtc": { "minLength": 1, "type": "string", "format": "date-time" } } }, "InboxChannelTicketingSetting": { "required": [ "contractVersion", "channelConnectionId", "channelKey", "address", "status", "isInboundEnabled", "isTicketingEnabled", "nextTicketNumber" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "channelConnectionId": { "minLength": 1, "type": "string", "format": "uuid" }, "channelKey": { "minLength": 1, "pattern": "^(email|sms)$", "type": "string" }, "displayLabel": { "type": [ "null", "string" ] }, "address": { "minLength": 1, "type": "string" }, "inboundAddress": { "type": [ "null", "string" ] }, "isInboundEnabled": { "type": "boolean" }, "status": { "minLength": 1, "type": "string" }, "isTicketingEnabled": { "type": "boolean" }, "ticketPrefix": { "type": [ "null", "string" ] }, "nextTicketNumber": { "type": "integer", "format": "int64" } } }, "InboxChannelTicketingSettings": { "required": [ "contractVersion", "canManage", "channels" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canManage": { "type": "boolean" }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/InboxChannelTicketingSetting" } } } }, "InboxEmailTicketingSetting": { "required": [ "channelConnectionId", "displayLabel", "emailAddress", "inboundAddress", "isInboundEnabled", "status", "isTicketingEnabled", "ticketPrefix", "nextTicketNumber" ], "type": "object", "properties": { "channelConnectionId": { "minLength": 1, "type": "string", "format": "uuid" }, "displayLabel": { "minLength": 1, "type": "string" }, "emailAddress": { "minLength": 1, "type": "string", "format": "email" }, "inboundAddress": { "minLength": 1, "type": "string" }, "isInboundEnabled": { "type": "boolean" }, "status": { "minLength": 1, "type": "string" }, "isTicketingEnabled": { "type": "boolean" }, "ticketPrefix": { "minLength": 1, "type": "string" }, "nextTicketNumber": { "type": "integer", "format": "int64" } } }, "InboxEmailTicketingSettings": { "required": [ "canManage", "mailboxes" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canManage": { "type": "boolean" }, "mailboxes": { "type": "array", "items": { "$ref": "#/components/schemas/InboxEmailTicketingSetting" } } } }, "InboxItemDetail": { "required": [ "inboxItemId", "appAccountId", "recordId", "source", "document" ], "type": "object", "properties": { "inboxItemId": { "minLength": 1, "type": "string", "format": "uuid" }, "appAccountId": { "minLength": 1, "type": "string", "format": "uuid" }, "recordId": { "minLength": 1, "type": "string", "format": "uuid" }, "source": { "$ref": "#/components/schemas/InboxSourceReference" }, "document": { "$ref": "#/components/schemas/JsonElement" } } }, "InboxNotification": { "required": [ "inboxItemId", "source", "subject", "bodyText", "notificationType", "priority", "createdUtc", "isRead", "sourceTableName" ], "type": "object", "properties": { "inboxItemId": { "minLength": 1, "type": "string", "format": "uuid" }, "source": { "$ref": "#/components/schemas/InboxSourceReference" }, "subject": { "minLength": 1, "type": "string" }, "bodyText": { "minLength": 1, "type": "string" }, "notificationType": { "minLength": 1, "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "createdUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "isRead": { "type": "boolean" }, "sourceTableName": { "minLength": 1, "type": "string" } } }, "InboxQueueItem": { "required": [ "inboxItemId", "source", "inboxQueueId", "queueName", "assignedToUserId", "assignedDataRoleId", "status", "goClawStatus", "priority", "subject", "previewText", "activityVersion", "newActivityCount", "firstReceivedUtc", "lastActivityUtc", "dueUtc", "snoozedUntilUtc", "aiIntent", "aiCategory", "aiRiskLevel", "aiConfidence", "aiSummary", "isUnread", "lastReadActivityVersion", "ticket" ], "type": "object", "properties": { "inboxItemId": { "minLength": 1, "type": "string", "format": "uuid" }, "source": { "$ref": "#/components/schemas/InboxSourceReference" }, "inboxQueueId": { "minLength": 1, "type": "string", "format": "uuid" }, "queueName": { "minLength": 1, "type": "string" }, "assignedToUserId": { "minLength": 1, "type": "string", "format": "uuid" }, "assignedDataRoleId": { "type": "integer", "format": "int32" }, "status": { "minLength": 1, "type": "string" }, "goClawStatus": { "minLength": 1, "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "subject": { "minLength": 1, "type": "string" }, "previewText": { "minLength": 1, "type": "string" }, "activityVersion": { "type": "integer", "format": "int64" }, "newActivityCount": { "type": "integer", "format": "int32" }, "firstReceivedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "lastActivityUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "dueUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "snoozedUntilUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "aiIntent": { "minLength": 1, "type": "string" }, "aiCategory": { "minLength": 1, "type": "string" }, "aiRiskLevel": { "minLength": 1, "type": "string" }, "aiConfidence": { "type": "number", "format": "double" }, "aiSummary": { "minLength": 1, "type": "string" }, "isUnread": { "type": "boolean" }, "lastReadActivityVersion": { "type": "integer", "format": "int64" }, "ticket": { "$ref": "#/components/schemas/InboxTicketReference" } } }, "InboxQueuePage": { "required": [ "items", "pageSize", "hasMore", "totalRecords", "totalIsExact", "nextPriority", "nextLastActivityUtc", "nextInboxItemId" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InboxQueueItem" } }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalIsExact": { "type": "boolean" }, "nextPriority": { "type": "integer", "format": "int32" }, "nextLastActivityUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "nextInboxItemId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "InboxSourceReference": { "required": [ "sourceType", "sourceKey", "sourceRecordId", "sourcePrimaryId", "externalSourceKey", "conversationId", "contactRecordId" ], "type": "object", "properties": { "sourceType": { "minLength": 1, "type": "string" }, "sourceKey": { "minLength": 1, "type": "string" }, "sourceRecordId": { "minLength": 1, "type": "string", "format": "uuid" }, "sourcePrimaryId": { "minLength": 1, "type": "string", "format": "uuid" }, "externalSourceKey": { "minLength": 1, "type": "string" }, "conversationId": { "minLength": 1, "type": "string", "format": "uuid" }, "contactRecordId": { "minLength": 1, "type": "string", "format": "uuid" } } }, "InboxTicketReference": { "required": [ "channelConnectionId", "prefix", "number", "openedUtc" ], "type": "object", "properties": { "channelConnectionId": { "minLength": 1, "type": "string", "format": "uuid" }, "prefix": { "minLength": 1, "type": "string" }, "number": { "type": "integer", "format": "int64" }, "openedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "key": { "type": [ "null", "string" ] } } }, "JsonElement": { }, "KnowledgeArticleDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "KnowledgeArticleFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "KnowledgeArticleWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "title": { "type": [ "null", "string" ] }, "articleBody": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "isPublished": { "type": "boolean" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/KnowledgeArticleDynamicFieldInput" } } } }, "KnowledgeCoreCollectionRequest": { "type": "object", "properties": { "collectionId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "parentCollectionId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultReviewPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "isSupportCollection": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" } } }, "KnowledgeCoreOwnerRequest": { "type": "object", "properties": { "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "responsibilityType": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" } } }, "KnowledgeCoreRestoreRequest": { "type": "object", "properties": { "knowledgeRevisionId": { "type": "string", "format": "uuid" }, "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "changeNote": { "type": [ "null", "string" ] } } }, "KnowledgeCoreTransitionRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "changeNote": { "type": [ "null", "string" ] } } }, "KnowledgeCoreWriteRequest": { "type": "object", "properties": { "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "slug": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "articleBody": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "reviewPolicyId": { "type": [ "null", "string" ], "format": "uuid" }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "changeNote": { "type": [ "null", "string" ] } } }, "KnowledgeFeedbackRequest": { "type": "object", "properties": { "contextRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "feedbackType": { "type": [ "null", "string" ] }, "comment": { "type": [ "null", "string" ] } } }, "KnowledgeQuestionAnswerRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "answerText": { "type": [ "null", "string" ] }, "answerKnowledgeRecordId": { "type": [ "null", "string" ], "format": "uuid" } } }, "KnowledgeQuestionAssignRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" } } }, "KnowledgeQuestionConvertRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "slug": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "knowledgeType": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "reviewPolicyId": { "type": [ "null", "string" ], "format": "uuid" } } }, "KnowledgeQuestionCreateRequest": { "type": "object", "properties": { "questionText": { "type": [ "null", "string" ] }, "contextRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "suggestedOwnerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "suggestedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" } } }, "KnowledgeRelationRequest": { "type": "object", "properties": { "knowledgeRecordId": { "type": "string", "format": "uuid" }, "relationKey": { "type": [ "null", "string" ] } } }, "KnowledgeReviewReassignRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "assignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "assignedDataRoleId": { "type": [ "null", "integer" ], "format": "int32" } } }, "KnowledgeReviewTransitionRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "outcome": { "type": [ "null", "string" ] }, "reviewNote": { "type": [ "null", "string" ] } } }, "MailReaderFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "MailReaderReadRequest": { "type": "object", "properties": { "isRead": { "type": "boolean" } } }, "NotificationFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "NotificationStateRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": "string", "format": "date-time" }, "markRead": { "type": [ "null", "boolean" ] }, "dismiss": { "type": [ "null", "boolean" ] } } }, "OutsideFormBrowserChallengeConfiguration": { "type": "object", "properties": { "provider": { "type": [ "null", "string" ] }, "action": { "type": [ "null", "string" ] }, "configured": { "type": "boolean" }, "siteKey": { "type": [ "null", "string" ] } } }, "OutsideFormEndpoint": { "type": "object", "properties": { "serverSecret": { "maxLength": 64, "minLength": 64, "pattern": "^[0-9A-Fa-f]{64}$", "type": [ "null", "string" ], "description": "One-time 64-character server secret. Returned only on ServerSecret creation, explicit rotation, or a browser-to-server mode change. Never returned by list or ordinary update; store it only on a trusted server." }, "contractVersion": { "type": "integer", "format": "int32" }, "endpointId": { "type": "string", "format": "uuid" }, "endpointKey": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "submissionMode": { "type": [ "null", "string" ] }, "allowedOrigin": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "targetDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "isActive": { "type": "boolean" }, "revision": { "type": "integer", "format": "int64" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "OutsideFormEndpointCreateRequest": { "required": [ "endpointKey", "displayName", "submissionMode" ], "type": "object", "properties": { "endpointKey": { "maxLength": 100, "minLength": 1, "type": "string" }, "displayName": { "maxLength": 200, "minLength": 1, "type": "string" }, "submissionMode": { "minLength": 1, "enum": [ "ServerSecret", "PublicBrowser" ], "type": "string" }, "allowedOrigin": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "targetDataRoleId": { "maximum": 2147483647, "minimum": 1, "type": [ "null", "integer" ], "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "OutsideFormEndpointPage": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "hasMore": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OutsideFormEndpointSummary" } } } }, "OutsideFormEndpointSummary": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "endpointId": { "type": "string", "format": "uuid" }, "endpointKey": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "submissionMode": { "type": [ "null", "string" ] }, "allowedOrigin": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "targetDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "isActive": { "type": "boolean" }, "revision": { "type": "integer", "format": "int64" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "OutsideFormSubmission": { "type": "object", "properties": { "submissionId": { "type": "string", "format": "uuid" }, "endpointId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "inboxItemId": { "type": "string", "format": "uuid" }, "formData": { "$ref": "#/components/schemas/JsonElement" }, "createdUtc": { "type": "string", "format": "date-time" } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "RecordActivityFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "RecordGraphAddRelationRequest": { "required": [ "toRecordId", "relationKey" ], "type": "object", "properties": { "toRecordId": { "minLength": 1, "type": "string", "format": "uuid" }, "relationKey": { "maxLength": 100, "minLength": 1, "pattern": ".*\\S.*", "type": "string" } } }, "RecordGraphFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "ReservationDetail": { "required": [ "followups", "events" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "reservationProductId": { "type": "string", "format": "uuid" }, "contactRecordId": { "type": "string", "format": "uuid" }, "contactPhone": { "type": [ "null", "string" ] }, "calendarRecordId": { "type": "string", "format": "uuid" }, "calendarEventId": { "type": "string", "format": "uuid" }, "resourceBookingId": { "type": [ "null", "string" ], "format": "uuid" }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "paymentId": { "type": [ "null", "string" ], "format": "uuid" }, "sourceChannel": { "type": [ "null", "string" ] }, "customerNotes": { "type": [ "null", "string" ] }, "internalNotes": { "type": [ "null", "string" ] }, "cancellationReason": { "type": [ "null", "string" ] }, "cancelledUtc": { "type": [ "null", "string" ], "format": "date-time" }, "checkedInUtc": { "type": [ "null", "string" ], "format": "date-time" }, "completedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "createdUtc": { "type": "string", "format": "date-time" }, "followups": { "type": "array", "items": { "$ref": "#/components/schemas/ReservationFollowup" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ReservationEvent" } }, "recordId": { "type": "string", "format": "uuid" }, "reservationId": { "type": "string", "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ], "format": "email" }, "assignedUserId": { "type": "string", "format": "uuid" }, "assignedUserName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "timeZoneId": { "type": [ "null", "string" ] }, "partySize": { "type": "integer", "format": "int32" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "paymentStatus": { "type": [ "null", "string" ] }, "holdExpiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "ReservationEvent": { "type": "object", "properties": { "eventType": { "type": [ "null", "string" ] }, "actorUserId": { "type": [ "null", "string" ], "format": "uuid" }, "correlationId": { "type": [ "null", "string" ], "format": "uuid" }, "detail": { }, "createdUtc": { "type": "string", "format": "date-time" } } }, "ReservationFollowup": { "type": "object", "properties": { "reservationFollowupId": { "type": "string", "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "scheduledUtc": { "type": "string", "format": "date-time" }, "recipientEmail": { "type": [ "null", "string" ], "format": "email" }, "subject": { "type": [ "null", "string" ] }, "deliveryStatus": { "type": [ "null", "string" ] }, "outboundMessageId": { "type": [ "null", "string" ], "format": "uuid" }, "attemptCount": { "type": "integer", "format": "int32" }, "sentUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ReservationFollowupWriteRequest": { "required": [ "expectedUpdatedUtc", "followupType", "scheduledUtc", "recipientEmail", "subject" ], "type": "object", "properties": { "expectedUpdatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "followupType": { "minLength": 1, "type": "string" }, "scheduledUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "recipientEmail": { "minLength": 1, "type": "string", "format": "email" }, "subject": { "minLength": 1, "type": "string" }, "bodyText": { "type": [ "null", "string" ] } } }, "ReservationListResponse": { "required": [ "items" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReservationSummary" } } } }, "ReservationMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "chargeIntentId": { "type": [ "null", "string" ], "format": "uuid" }, "calendarRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "followupType": { "type": [ "null", "string" ] }, "idempotentReplay": { "type": "boolean" }, "updatedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ReservationProduct": { "type": "object", "properties": { "reservationProductId": { "type": "string", "format": "uuid" }, "productKey": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "durationMinutes": { "type": "integer", "format": "int32" }, "bufferBeforeMinutes": { "type": "integer", "format": "int32" }, "bufferAfterMinutes": { "type": "integer", "format": "int32" }, "priceCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "concurrentCapacity": { "type": "integer", "format": "int32" }, "maxPartySize": { "type": "integer", "format": "int32" }, "defaultLocationId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultLocationName": { "type": [ "null", "string" ] }, "defaultResourceId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultResourceName": { "type": [ "null", "string" ] }, "defaultAssignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultAssignedUserName": { "type": [ "null", "string" ] }, "enforceAssigneeExclusivity": { "type": "boolean" }, "holdMinutes": { "type": "integer", "format": "int32" }, "preServiceFollowupMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "postServiceFollowupMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "preServiceSubject": { "type": [ "null", "string" ] }, "postServiceSubject": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "ReservationProductListResponse": { "required": [ "items" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReservationProduct" } } } }, "ReservationProductWriteRequest": { "required": [ "productKey", "productName", "durationMinutes" ], "type": "object", "properties": { "reservationProductId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "productKey": { "minLength": 1, "type": "string" }, "productName": { "minLength": 1, "type": "string" }, "description": { "type": [ "null", "string" ] }, "durationMinutes": { "type": "integer", "format": "int32" }, "bufferBeforeMinutes": { "type": "integer", "format": "int32" }, "bufferAfterMinutes": { "type": "integer", "format": "int32" }, "priceCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "concurrentCapacity": { "type": "integer", "format": "int32" }, "maxPartySize": { "type": "integer", "format": "int32" }, "defaultLocationId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultResourceId": { "type": [ "null", "string" ], "format": "uuid" }, "defaultAssignedUserId": { "type": [ "null", "string" ], "format": "uuid" }, "enforceAssigneeExclusivity": { "type": "boolean" }, "holdMinutes": { "type": "integer", "format": "int32" }, "preServiceFollowupMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "postServiceFollowupMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "preServiceSubject": { "type": [ "null", "string" ] }, "postServiceSubject": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" } } }, "ReservationPurchaseRequest": { "required": [ "reservationProductId", "startUtc", "timeZoneId", "idempotencyKey" ], "type": "object", "properties": { "reservationProductId": { "minLength": 1, "type": "string", "format": "uuid" }, "startUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "timeZoneId": { "minLength": 1, "type": "string" }, "partySize": { "type": "integer", "format": "int32" }, "assignedUserId": { "type": [ "null", "string" ], "description": "Use optionId from GET /v1/apps/{saasAppId}/modules/reservations/assignees as assignedUserId. The server revalidates eligibility and availability on write; lookupId is not a user ID.", "format": "uuid" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "contactRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ], "format": "email" }, "phone": { "type": [ "null", "string" ] }, "paymentMethodId": { "type": [ "null", "string" ], "format": "uuid" }, "idempotencyKey": { "minLength": 1, "type": "string" }, "sourceChannel": { "type": [ "null", "string" ] }, "customerNotes": { "type": [ "null", "string" ] }, "internalNotes": { "type": [ "null", "string" ] }, "preServiceFollowupUtc": { "type": [ "null", "string" ], "format": "date-time" }, "preServiceFollowupEmail": { "type": [ "null", "string" ], "format": "email" }, "postServiceFollowupUtc": { "type": [ "null", "string" ], "format": "date-time" }, "postServiceFollowupEmail": { "type": [ "null", "string" ], "format": "email" } } }, "ReservationRescheduleRequest": { "required": [ "expectedUpdatedUtc", "startUtc", "timeZoneId", "partySize", "assignedUserId" ], "type": "object", "properties": { "expectedUpdatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "startUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "timeZoneId": { "minLength": 1, "type": "string" }, "partySize": { "type": "integer", "format": "int32" }, "assignedUserId": { "minLength": 1, "type": "string", "description": "Use optionId from GET /v1/apps/{saasAppId}/modules/reservations/assignees as assignedUserId. The server revalidates eligibility and availability on write; lookupId is not a user ID.", "format": "uuid" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "customerNotes": { "type": [ "null", "string" ] }, "internalNotes": { "type": [ "null", "string" ] } } }, "ReservationStatusRequest": { "required": [ "expectedUpdatedUtc", "status" ], "type": "object", "properties": { "expectedUpdatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "status": { "minLength": 1, "enum": [ "Confirmed", "CheckedIn", "Completed", "Cancelled", "NoShow" ], "type": "string" }, "cancellationReason": { "type": [ "null", "string" ] } } }, "ReservationSummary": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "reservationId": { "type": "string", "format": "uuid" }, "reservationNumber": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ], "format": "email" }, "assignedUserId": { "type": "string", "format": "uuid" }, "assignedUserName": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "locationName": { "type": [ "null", "string" ] }, "startUtc": { "type": "string", "format": "date-time" }, "endUtc": { "type": "string", "format": "date-time" }, "timeZoneId": { "type": [ "null", "string" ] }, "partySize": { "type": "integer", "format": "int32" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "paymentStatus": { "type": [ "null", "string" ] }, "holdExpiresUtc": { "type": [ "null", "string" ], "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "SecretReference": { "required": [ "provider", "name" ], "type": "object", "properties": { "provider": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "version": { "type": [ "null", "string" ] } } }, "Stream": { "type": "string", "format": "binary" }, "SuggestionBatchApprovalResult": { "required": [ "suggestionBatchId" ], "type": "object", "properties": { "suggestionBatchId": { "minLength": 1, "type": "string", "format": "uuid" }, "executions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ApprovedActionExecution" } } } }, "SupportLane": { "required": [ "laneId", "name", "isActive", "revision", "goClawIsActive", "updatedUtc", "channels" ], "type": "object", "properties": { "laneId": { "minLength": 1, "type": "string", "format": "uuid" }, "name": { "minLength": 1, "type": "string" }, "description": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "revision": { "minLength": 1, "type": "string" }, "goClawUserId": { "type": [ "null", "string" ], "format": "uuid" }, "goClawName": { "type": [ "null", "string" ] }, "goClawIsActive": { "type": "boolean" }, "updatedUtc": { "minLength": 1, "type": "string" }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/SupportLaneChannel" } } } }, "SupportLaneChannel": { "required": [ "channelConnectionId", "channelKey", "displayLabel", "address", "status", "isInboundEnabled", "isTicketingEnabled", "updatedUtc" ], "type": "object", "properties": { "channelConnectionId": { "minLength": 1, "type": "string", "format": "uuid" }, "channelKey": { "minLength": 1, "pattern": "^(email|sms)$", "type": "string" }, "displayLabel": { "minLength": 1, "type": "string" }, "address": { "minLength": 1, "type": "string" }, "inboundAddress": { "type": [ "null", "string" ] }, "status": { "minLength": 1, "type": "string" }, "isInboundEnabled": { "type": "boolean" }, "isTicketingEnabled": { "type": "boolean" }, "updatedUtc": { "minLength": 1, "type": "string" } } }, "SupportLaneOption": { "required": [ "id", "label", "updatedUtc" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "format": "uuid" }, "label": { "minLength": 1, "type": "string" }, "address": { "type": [ "null", "string" ] }, "updatedUtc": { "minLength": 1, "type": "string" } } }, "SupportLaneOptionPage": { "required": [ "contractVersion", "kind", "items", "hasMore", "nextAfterId" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "kind": { "minLength": 1, "pattern": "^(email|sms|goclaw)$", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SupportLaneOption" } }, "hasMore": { "type": "boolean" }, "nextAfterId": { "minLength": 1, "type": [ "null", "string" ], "description": "Continue with afterId when hasMore is true; null marks the final page. No fixed lane-count cap.", "format": "uuid" } } }, "SupportLanePage": { "required": [ "contractVersion", "items", "hasMore", "nextAfterId" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SupportLane" } }, "hasMore": { "type": "boolean" }, "nextAfterId": { "minLength": 1, "type": [ "null", "string" ], "description": "Continue with afterId when hasMore is true; null marks the final page. No fixed lane-count cap.", "format": "uuid" } } }, "SupportLaneReceipt": { "required": [ "contractVersion", "laneId", "revision", "isActive", "created", "updatedUtc" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "laneId": { "minLength": 1, "type": "string", "format": "uuid" }, "revision": { "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "created": { "type": "boolean" }, "updatedUtc": { "minLength": 1, "type": "string" } } }, "SupportLaneRetireRequest": { "required": [ "expectedRevision", "confirmDetachChannels" ], "type": "object", "properties": { "expectedRevision": { "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string" }, "confirmDetachChannels": { "type": "boolean" } } }, "SupportLaneSaveRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": [ "null", "string" ] }, "expectedRevision": { "pattern": "^[1-9][0-9]{0,18}$", "type": [ "null", "string" ] }, "goClawUserId": { "type": [ "null", "string" ], "format": "uuid" }, "emailChannelId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedEmailUpdatedUtc": { "maxLength": 28, "minLength": 0, "type": [ "null", "string" ] }, "smsChannelId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedSmsUpdatedUtc": { "maxLength": 28, "minLength": 0, "type": [ "null", "string" ] } } }, "SupportLearningCandidateListResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SupportLearningCandidateSummary" } } } }, "SupportLearningCandidateSummary": { "type": "object", "properties": { "supportResolutionLinkId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "reviewTaskRecordId": { "type": "string", "format": "uuid" }, "sourceInboxItemId": { "type": "string", "format": "uuid" }, "sourceActivityVersion": { "type": "integer", "format": "int64" }, "sanitizationPolicyVersion": { "type": [ "null", "string" ] }, "candidateContentHash": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" } } }, "SupportResolutionCandidateRequest": { "type": "object", "properties": { "inboxItemId": { "type": "string", "format": "uuid" }, "expectedActivityVersion": { "type": "integer", "format": "int64" }, "idempotencyKey": { "type": [ "null", "string" ] }, "symptom": { "type": [ "null", "string" ] }, "productArea": { "type": [ "null", "string" ] }, "likelyCause": { "type": [ "null", "string" ] }, "diagnosticSteps": { "type": [ "null", "string" ] }, "verifiedResolution": { "type": [ "null", "string" ] }, "affectedVersion": { "type": [ "null", "string" ] }, "ownerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "ownerDataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "knownPrivateValues": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "SupportResolutionCandidateResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "supportResolutionLinkId": { "type": "string", "format": "uuid" }, "knowledgeArticleId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "reviewTaskRecordId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": [ "null", "string" ] }, "authorityLevel": { "type": [ "null", "string" ] }, "isAiEligible": { "type": "boolean" }, "isSupportEligible": { "type": "boolean" }, "candidateContentHash": { "type": [ "null", "string" ] }, "correlationId": { "type": "string", "format": "uuid" }, "replayed": { "type": "boolean" } } }, "TenantApprovalActionEdit": { "type": "object", "properties": { "aiActionSuggestionId": { "type": "string", "format": "uuid" }, "suggestedInput": { "$ref": "#/components/schemas/JsonElement" } } }, "TenantApproveSuggestionBatchRequest": { "type": "object", "properties": { "reviewNotes": { "type": [ "null", "string" ] }, "editedDraftResponse": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "actionEdits": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantApprovalActionEdit" } } } }, "TenantAssetListResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "canManage": { "type": "boolean" }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantAssetSummary" } } } }, "TenantAssetMutationResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "assetId": { "type": "string", "format": "uuid" }, "url": { "type": [ "null", "string" ] } } }, "TenantAssetSummary": { "type": "object", "properties": { "assetId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "thumbnailUrl": { "type": [ "null", "string" ] }, "folderPath": { "type": [ "null", "string" ] }, "assetType": { "type": [ "null", "string" ] }, "format": { "type": [ "null", "string" ] }, "contentType": { "type": [ "null", "string" ] }, "fileSizeBytes": { "type": "integer", "format": "int64" }, "width": { "type": [ "null", "integer" ], "format": "int32" }, "height": { "type": [ "null", "integer" ], "format": "int32" }, "durationSeconds": { "type": [ "null", "number" ], "format": "double" }, "isShared": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "modifiedUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "TenantChannelTicketingRequest": { "required": [ "isTicketingEnabled" ], "type": "object", "properties": { "isTicketingEnabled": { "type": "boolean" }, "ticketPrefix": { "maxLength": 12, "minLength": 2, "pattern": "^[A-Za-z0-9]+$", "type": [ "null", "string" ] } } }, "TenantChargeWrite": { "type": "object", "properties": { "paymentMethodId": { "type": "string", "format": "uuid" }, "amountCents": { "type": "integer", "format": "int64" }, "currencyCode": { "type": [ "null", "string" ] }, "idempotencyKey": { "type": [ "null", "string" ] } } }, "TenantCustomFieldList": { "required": [ "contractVersion", "moduleKey", "pageKey", "allowTenantFields", "maxTenantFields", "fields" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "minLength": 1, "type": "string" }, "pageKey": { "minLength": 1, "type": "string" }, "allowTenantFields": { "type": "boolean" }, "maxTenantFields": { "type": "integer", "format": "int32" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinition" } } } }, "TenantDeliveryRetryReceipt": { "required": [ "outboundMessageId" ], "type": "object", "properties": { "outboundMessageId": { "minLength": 1, "type": "string", "format": "uuid" }, "deliveryStatus": { "type": [ "null", "string" ] } } }, "TenantEmailTicketingRequest": { "type": "object", "properties": { "isTicketingEnabled": { "type": "boolean" }, "ticketPrefix": { "maxLength": 12, "minLength": 2, "pattern": "^[A-Za-z0-9]+$", "type": [ "null", "string" ] } } }, "TenantInboxHumanStateRequest": { "type": "object", "properties": { "expectedActivityVersion": { "type": "integer", "format": "int64" }, "isUnread": { "type": [ "null", "boolean" ] }, "status": { "enum": [ "New", "Open", "WaitingCustomer", "WaitingInternal", "Snoozed", "Resolved", "Closed" ], "type": "string" }, "snoozedUntilUtc": { "type": [ "null", "string" ], "format": "date-time" }, "priority": { "type": [ "null", "integer" ], "format": "int32" }, "assignmentMode": { "enum": [ "Me", "Unassigned" ], "type": "string" } } }, "TenantInboxReplyRequest": { "type": "object", "properties": { "expectedActivityVersion": { "type": "integer", "format": "int64" }, "direction": { "type": [ "null", "string" ] }, "bodyText": { "type": [ "null", "string" ] }, "subject": { "type": [ "null", "string" ] }, "toAddress": { "type": [ "null", "string" ] }, "ccAddress": { "type": [ "null", "string" ] }, "scheduledSendUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "TenantLegoAction": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "kind": { "type": [ "null", "string" ] }, "inputFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "requiresRecordId": { "type": "boolean" }, "requiresExpectedRevision": { "type": "boolean" }, "requiresConfirmation": { "type": "boolean" }, "result": { "$ref": "#/components/schemas/TenantLegoActionResult" } } }, "TenantLegoActionResult": { "type": "object", "properties": { "returnsRevision": { "type": "boolean" }, "canConflict": { "type": "boolean" }, "refreshBindingId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TenantLegoBinding": { "type": "object", "properties": { "bindingId": { "type": "string", "format": "uuid" }, "resourceId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "presentationKind": { "type": [ "null", "string" ] }, "defaultPageSize": { "type": "integer", "format": "int32" }, "maximumPageSize": { "type": "integer", "format": "int32" }, "filterFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "sortFieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "TenantLegoCatalog": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "catalogId": { "type": "string", "format": "uuid" }, "catalogVersion": { "type": "integer", "format": "int32" }, "resources": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoResource" } }, "fieldCatalogs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoFieldCatalog" } }, "bindings": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoBinding" } }, "actions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoAction" } }, "components": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoComponent" } }, "vocabularies": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoVocabulary" } }, "lookups": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoLookupDefinition" } } } }, "TenantLegoChoice": { "type": "object", "properties": { "choiceId": { "type": "string", "format": "uuid" }, "value": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] } } }, "TenantLegoComponent": { "type": "object", "properties": { "componentId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "rendererKey": { "type": [ "null", "string" ] }, "trustLevel": { "type": [ "null", "string" ] }, "resourceId": { "type": [ "null", "string" ], "format": "uuid" }, "bindingId": { "type": [ "null", "string" ], "format": "uuid" }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "fieldIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "defaultProps": { "$ref": "#/components/schemas/JsonElement" } } }, "TenantLegoField": { "type": "object", "properties": { "fieldId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "required": { "type": "boolean" }, "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "maximumLength": { "type": [ "null", "integer" ], "format": "int32" }, "minimum": { "type": [ "null", "number" ], "format": "double" }, "maximum": { "type": [ "null", "number" ], "format": "double" }, "choiceIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "lookupId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TenantLegoFieldCatalog": { "type": "object", "properties": { "fieldCatalogId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "fields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoField" } } } }, "TenantLegoLookupDefinition": { "type": "object", "properties": { "lookupId": { "type": "string", "format": "uuid" }, "kind": { "type": [ "null", "string" ] }, "maximumPageSize": { "type": "integer", "format": "int32" } } }, "TenantLegoLookupOption": { "type": "object", "properties": { "optionId": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] } } }, "TenantLegoLookupPage": { "required": [ "items" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "lookupId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantLegoLookupOption" } } } }, "TenantLegoPresentationAction": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "label": { "type": [ "null", "string" ] }, "tone": { "type": [ "null", "string" ] }, "requiresConfirmation": { "type": "boolean" }, "requiresExpectedRevision": { "type": "boolean" } } }, "TenantLegoResource": { "type": "object", "properties": { "resourceId": { "type": "string", "format": "uuid" }, "moduleId": { "type": "string", "format": "uuid" }, "key": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "fieldCatalogId": { "type": "string", "format": "uuid" }, "bindingIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "actionIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "TenantLegoVocabulary": { "type": "object", "properties": { "vocabularyId": { "type": "string", "format": "uuid" }, "fieldId": { "type": "string", "format": "uuid" }, "allowsCustomValue": { "type": "boolean" }, "choices": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantLegoChoice" } } } }, "TenantModuleCapabilities": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "moduleKey": { "type": [ "null", "string" ] }, "recordId": { "type": [ "null", "string" ], "format": "uuid" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } } }, "TenantPaymentConnectorWrite": { "type": "object", "properties": { "paymentConnectorId": { "type": [ "null", "string" ], "format": "uuid" }, "connectorKey": { "type": [ "null", "string" ] }, "credentialReference": { "type": [ "null", "string" ] }, "webhookSecretReference": { "type": [ "null", "string" ] }, "isTestMode": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "TenantPaymentPolicyWrite": { "type": "object", "properties": { "collectionMode": { "enum": [ "Disabled", "Optional", "Required" ], "type": "string" }, "chargeTiming": { "enum": [ "AtCreation", "Manual", "OnCompletion" ], "type": "string" }, "depositBasisPoints": { "type": "integer", "format": "int32" }, "currencyCode": { "type": [ "null", "string" ] }, "allowPartialPayments": { "type": "boolean" }, "minimumChargeCents": { "type": "integer", "format": "int64" }, "requirePaidBeforeCompletion": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "TenantRecordCountResponse": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int64" }, "totalIsExact": { "type": "boolean" }, "browseLimit": { "type": "integer", "format": "int32" } } }, "TenantRejectSuggestionBatchRequest": { "type": "object", "properties": { "reviewNotes": { "type": [ "null", "string" ] } } }, "TenantReviewDispositionRequest": { "type": "object", "properties": { "reviewNotes": { "type": [ "null", "string" ] } } }, "TenantRuntimeBootstrap": { "required": [ "contractVersion", "runtimeRequestId", "generatedUtc", "shell", "page" ], "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "runtimeRequestId": { "minLength": 1, "type": "string", "format": "uuid" }, "generatedUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "shell": { "$ref": "#/components/schemas/JsonElement" }, "components": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantRuntimeComponentContract" } }, "page": { "$ref": "#/components/schemas/TenantRuntimePage" } } }, "TenantRuntimeComponentContract": { "required": [ "componentId", "scope", "componentKey", "tier", "displayName", "category", "manifestJson", "moduleRef", "version", "authorship" ], "type": "object", "properties": { "componentId": { "minLength": 1, "type": "string", "format": "uuid" }, "scope": { "minLength": 1, "type": "string" }, "componentKey": { "minLength": 1, "type": "string" }, "tier": { "type": "integer", "format": "int32" }, "displayName": { "minLength": 1, "type": "string" }, "category": { "minLength": 1, "type": "string" }, "manifestJson": { "$ref": "#/components/schemas/JsonElement" }, "moduleRef": { "minLength": 1, "type": "string" }, "version": { "type": "integer", "format": "int32" }, "authorship": { "minLength": 1, "type": "string" } } }, "TenantRuntimeDataBindingBatch": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "bindings": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TenantRuntimeDataBindingBatchItem" } } } }, "TenantRuntimeDataBindingBatchItem": { "required": [ "bindingKey", "status", "data", "code", "error" ], "type": "object", "properties": { "bindingKey": { "minLength": 1, "type": "string" }, "status": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/JsonElement" }, "code": { "minLength": 1, "type": "string" }, "error": { "minLength": 1, "type": "string" } } }, "TenantRuntimeDataBindingBatchRequest": { "required": [ "bindingKeys" ], "type": "object", "properties": { "bindingKeys": { "maxItems": 24, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "TenantRuntimePage": { "required": [ "pageKey", "origin", "pageVersion", "entitlementFellBack", "pageJson", "metadataJson", "designTokensJson" ], "type": "object", "properties": { "pageKey": { "minLength": 1, "type": "string" }, "origin": { "minLength": 1, "type": "string" }, "pageVersion": { "type": "integer", "format": "int32" }, "entitlementFellBack": { "type": "boolean" }, "pageJson": { "$ref": "#/components/schemas/JsonElement" }, "metadataJson": { "$ref": "#/components/schemas/JsonElement" }, "designTokensJson": { "$ref": "#/components/schemas/JsonElement" } } }, "TenantSnowflakeDestination": { "type": "object", "properties": { "snowflakeDestinationId": { "type": "string", "format": "uuid" }, "saasAppId": { "type": "string", "format": "uuid" }, "appAccountId": { "type": "string", "format": "uuid" }, "accountIdentifier": { "type": [ "null", "string" ] }, "warehouse": { "type": [ "null", "string" ] }, "databaseName": { "type": [ "null", "string" ] }, "schemaName": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "principalName": { "type": [ "null", "string" ] }, "authenticationType": { "type": [ "null", "string" ] }, "credentialProvider": { "type": [ "null", "string" ] }, "credentialConfigured": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "createdUtc": { "type": "string", "format": "date-time" }, "updatedUtc": { "type": "string", "format": "date-time" }, "rowVersion": { "type": [ "null", "string" ] }, "publicKey": { "type": [ "null", "string" ] }, "verifiedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "lastResult": { "type": [ "null", "string" ] }, "operationInProgress": { "type": "boolean" }, "runs": { "$ref": "#/components/schemas/JsonElement" }, "checkpoints": { "$ref": "#/components/schemas/JsonElement" } } }, "TenantSnowflakeSaveRequest": { "required": [ "accountIdentifier", "databaseName", "schemaName", "roleName", "principalName" ], "type": "object", "properties": { "accountIdentifier": { "maxLength": 63, "minLength": 1, "type": "string" }, "databaseName": { "maxLength": 255, "minLength": 1, "type": "string" }, "schemaName": { "maxLength": 255, "minLength": 1, "type": "string" }, "roleName": { "maxLength": 255, "minLength": 1, "type": "string" }, "principalName": { "maxLength": 255, "minLength": 1, "type": "string" }, "generateKey": { "type": "boolean" }, "expectedRowVersion": { "type": [ "null", "string" ] } } }, "TenantSnowflakeSettings": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "exportAvailable": { "type": "boolean" }, "destination": { "$ref": "#/components/schemas/TenantSnowflakeDestination" }, "setupSql": { "type": [ "null", "string" ] }, "keyRotationSql": { "type": [ "null", "string" ] }, "ingestionMode": { "type": [ "null", "string" ] }, "schedulingAvailable": { "type": "boolean" } } }, "TenantSnowpipeEnabledRequest": { "required": [ "expectedRowVersion", "isEnabled" ], "type": "object", "properties": { "expectedRowVersion": { "minLength": 1, "type": "string" }, "isEnabled": { "type": "boolean" } } }, "TenantSnowpipeOperationRequest": { "required": [ "expectedRowVersion" ], "type": "object", "properties": { "expectedRowVersion": { "minLength": 1, "type": "string" } } }, "TransferDeveloperOrganizationOwnershipRequest": { "required": [ "currentOwnerUserId", "targetUserId", "expectedTargetRevisionUtc" ], "type": "object", "properties": { "currentOwnerUserId": { "minLength": 1, "type": "string", "format": "uuid" }, "targetUserId": { "minLength": 1, "type": "string", "format": "uuid" }, "expectedTargetRevisionUtc": { "minLength": 1, "type": "string" } } }, "UpdateDeveloperOrganizationRequest": { "required": [ "expectedUpdatedUtc", "accountName", "primaryEmail", "status" ], "type": "object", "properties": { "expectedUpdatedUtc": { "minLength": 1, "type": "string" }, "accountName": { "maxLength": 200, "minLength": 1, "type": "string" }, "primaryEmail": { "maxLength": 320, "minLength": 1, "type": "string", "format": "email" }, "status": { "minLength": 1, "enum": [ "Active", "Inactive" ], "type": "string" } } }, "UpdateDeveloperTenantUserRequest": { "required": [ "expectedRevisionUtc" ], "type": "object", "properties": { "expectedRevisionUtc": { "minLength": 1, "type": "string", "format": "date-time" }, "email": { "maxLength": 320, "minLength": 0, "type": [ "null", "string" ], "format": "email" }, "displayName": { "maxLength": 200, "minLength": 0, "type": [ "null", "string" ] }, "userTypeKey": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "status": { "enum": [ "Active", "Inactive" ], "type": "string" }, "dataRoleIds": { "maxItems": 100, "minItems": 1, "type": [ "null", "array" ], "items": { "type": "integer", "format": "int32" } }, "locationScopeMode": { "enum": [ "all", "selected" ], "type": "string" }, "locationIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "UpsertDeveloperDataRoleRequest": { "required": [ "roleName" ], "type": "object", "properties": { "dataRoleId": { "type": [ "null", "integer" ], "format": "int32" }, "expectedRevisionUtc": { "type": [ "null", "string" ] }, "roleName": { "maxLength": 100, "minLength": 1, "type": "string" }, "canRead": { "type": "boolean" }, "canCreate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canExport": { "type": "boolean" }, "canReadRecords": { "type": "boolean" }, "canAiReadRecords": { "type": "boolean" }, "canExportRecords": { "type": "boolean" }, "canBillRecords": { "type": "boolean" }, "canViewTrustRecords": { "type": "boolean" }, "canApproveDisbursementRecords": { "type": "boolean" }, "isActive": { "type": "boolean" }, "permissionKeys": { "maxItems": 200, "type": [ "null", "array" ], "items": { "type": "string" } } } }, "UpsertDeveloperLocationRequest": { "required": [ "locationName" ], "type": "object", "properties": { "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "expectedUpdatedUtc": { "type": [ "null", "string" ] }, "locationName": { "maxLength": 200, "minLength": 1, "type": "string" }, "locationCode": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "address1": { "maxLength": 300, "minLength": 0, "type": [ "null", "string" ] }, "city": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "stateProvince": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "postalCode": { "maxLength": 30, "minLength": 0, "type": [ "null", "string" ] }, "country": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "timeZone": { "maxLength": 100, "minLength": 0, "type": [ "null", "string" ] }, "phone": { "maxLength": 50, "minLength": 0, "type": [ "null", "string" ] }, "managerUserId": { "type": [ "null", "string" ], "format": "uuid" }, "isActive": { "type": "boolean" }, "sortOrder": { "maximum": 100000, "minimum": -100000, "type": "integer", "format": "int32" } } }, "WebLinkDynamicFieldInput": { "type": "object", "properties": { "fieldKey": { "type": [ "null", "string" ] }, "valueText": { "type": [ "null", "string" ] }, "valueInt": { "type": [ "null", "integer" ], "format": "int64" }, "valueDecimal": { "type": [ "null", "number" ], "format": "double" }, "valueDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "valueBool": { "type": [ "null", "boolean" ] }, "valueGuid": { "type": [ "null", "string" ], "format": "uuid" }, "valueJson": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "clear": { "type": "boolean" } } }, "WebLinkFavoriteRequest": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "WebLinkRemovalResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "WebLinkWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "title": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/WebLinkDynamicFieldInput" } } } }, "WorkOrderAssignmentRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "assignedUserId": { "type": "string", "format": "uuid" }, "assignmentRole": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "WorkOrderRemovalResponse": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid" }, "objectKey": { "type": [ "null", "string" ] }, "deleted": { "type": "boolean" }, "correlationId": { "type": "string", "format": "uuid" } } }, "WorkOrdersPresentationDocumentResponse": { "required": [ "metrics", "recent", "byStatus", "trend", "table", "timeline" ], "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/DeveloperPresentationPartResponse" }, "recent": { "$ref": "#/components/schemas/DeveloperPresentationPartResponse" }, "byStatus": { "$ref": "#/components/schemas/DeveloperPresentationPartResponse" }, "trend": { "$ref": "#/components/schemas/DeveloperPresentationPartResponse" }, "table": { "$ref": "#/components/schemas/DeveloperPresentationPartResponse" }, "timeline": { "$ref": "#/components/schemas/DeveloperPresentationPartResponse" } } }, "WorkOrderStatusRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "status": { "enum": [ "Requested", "Scheduled", "Dispatched", "InProgress", "OnHold", "Completed", "Cancelled" ], "type": "string" } } }, "WorkOrderStatusTransition": { "type": "object", "properties": { "choiceId": { "type": "string", "format": "uuid" }, "value": { "type": [ "null", "string" ] }, "label": { "type": [ "null", "string" ] } } }, "WorkOrderStatusTransitions": { "type": "object", "properties": { "contractVersion": { "type": "integer", "format": "int32" }, "recordId": { "type": "string", "format": "uuid" }, "currentChoiceId": { "type": "string", "format": "uuid" }, "currentValue": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/WorkOrderStatusTransition" } } } }, "WorkOrderWriteRequest": { "type": "object", "properties": { "expectedUpdatedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "locationId": { "type": [ "null", "string" ], "format": "uuid" }, "customerRecordId": { "type": [ "null", "string" ], "format": "uuid" }, "workOrderNumber": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "priority": { "type": [ "null", "string" ] }, "scheduledStartUtc": { "type": [ "null", "string" ], "format": "date-time" }, "scheduledEndUtc": { "type": [ "null", "string" ], "format": "date-time" }, "dynamicFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CustomFieldValueWrite" } } } } }, "securitySchemes": { "DraftAppCredential": { "type": "http", "description": "A server-held draft app credential. It can receive only pages.draft.read and pages.draft.write and cannot publish or access live tenant data.", "scheme": "bearer", "bearerFormat": "bwk_draft_" }, "LiveAppCredential": { "type": "http", "description": "A server-held live app credential. Never expose this credential to browser or mobile code.", "scheme": "bearer", "bearerFormat": "bwk_live_" }, "DelegatedUserCredential": { "type": "http", "description": "A short-lived delegated-user credential for browser, mobile, or user-specific agent calls. The server revalidates its parent grant and TenantUser on every request.", "scheme": "bearer", "bearerFormat": "bwu_live_" } } }, "security": [ { "LiveAppCredential": [ ] } ], "tags": [ { "name": "MCP" }, { "name": "DeveloperAi" }, { "name": "DeveloperAppOpenApi" }, { "name": "DeveloperAssets" }, { "name": "DeveloperAuthContext" }, { "name": "DeveloperConnectorRegistry" }, { "name": "DeveloperCustomFields" }, { "name": "DeveloperDatabaseContracts" }, { "name": "DeveloperDataConnectors" }, { "name": "DeveloperHeadlessIdentity" }, { "name": "DeveloperOrganizationLifecycle" }, { "name": "DeveloperInboundEndpoints" }, { "name": "DeveloperInstalledServices" }, { "name": "DeveloperLogs" }, { "name": "DeveloperOAuthConnections" }, { "name": "DeveloperOutsideForms" }, { "name": "DeveloperPages" }, { "name": "DeveloperPaymentConnectors" }, { "name": "DeveloperPresentations" }, { "name": "DeveloperRecords" }, { "name": "DeveloperRuntimePages" }, { "name": "DeveloperSkills" }, { "name": "DeveloperThemes" }, { "name": "DeveloperWebhookDeliveries" }, { "name": "DeveloperWebhookSubscriptions" }, { "name": "GatewayMetadata" }, { "name": "PlatformOwnerOpenApi" }, { "name": "TenantActiveWorkplace" }, { "name": "TenantAiInsights" }, { "name": "TenantCalendar" }, { "name": "TenantChatRooms" }, { "name": "TenantChecklists" }, { "name": "TenantCompanyNews" }, { "name": "TenantContacts" }, { "name": "TenantConversations" }, { "name": "TenantDiscussionBoards" }, { "name": "TenantDynamicModules" }, { "name": "TenantFavorites" }, { "name": "TenantFiles" }, { "name": "TenantGlobalSearch" }, { "name": "TenantGoClawApprovals" }, { "name": "TenantKnowledgeArticles" }, { "name": "TenantKnowledgeCore" }, { "name": "TenantMailReader" }, { "name": "TenantNotifications" }, { "name": "TenantPayments" }, { "name": "TenantRecordActivity" }, { "name": "TenantRecordGraph" }, { "name": "TenantReservations" }, { "name": "TenantSnowflake" }, { "name": "TenantSupportLanes" }, { "name": "TenantUniversalInbox" }, { "name": "TenantWebLinks" }, { "name": "TenantWorkOrders" } ] }