diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json
index 820241c7b..c691380fc 100644
--- a/api-spec/openapiSpecv3-2_0.json
+++ b/api-spec/openapiSpecv3-2_0.json
@@ -21,14 +21,6 @@
],
"description": "Roles for version 10.4.0.cl"
},
- {
- "name": "26.6.0.cl",
- "id": "26.6.0.cl",
- "tags": [
- "26.6.0.cl"
- ],
- "description": "Roles for version 26.6.0.cl"
- },
{
"name": "10.15.0.cl",
"id": "10.15.0.cl",
@@ -61,6 +53,14 @@
],
"description": "Roles for version 26.5.0.cl"
},
+ {
+ "name": "26.6.0.cl",
+ "id": "26.6.0.cl",
+ "tags": [
+ "26.6.0.cl"
+ ],
+ "description": "Roles for version 26.6.0.cl"
+ },
{
"name": "9.0.0.cl",
"id": "9.0.0.cl",
@@ -270,6 +270,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -280,6 +292,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -290,6 +314,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -300,6 +336,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -333,6 +381,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Conversation"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Conversation created successfully",
+ "value": {
+ "conversation_identifier": "conv-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+ }
+ }
}
}
}
@@ -353,6 +409,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -363,6 +431,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -373,6 +453,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -383,79 +475,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/api/rest/2.0/ai/agent/instructions/get": {
- "get": {
- "operationId": "getAgentInstructions",
- "description": "\nBeta Version: 26.6.0.cl or later\n\nRetrieves the admin instructions currently configured for the AI agent (Spotter). Admin instructions are tenant- and org-scoped text that guide agent behavior across all conversations.\n\nRequires admin privileges. Only users with org admin access can retrieve agent instructions.\n\n#### Usage guidelines\n\nNo input parameters are required. The API returns the stored `AgentInstructions` record for the caller's tenant and org.\n\nIf no instructions have been configured yet, the API returns a record with an empty `instructions` field and `null` values for `id`, `created_at`, `updated_at`, and `last_updated_by`.\n\nIf the request is successful, the response includes:\n\n- `id`: unique identifier of the instructions record\n- `instructions`: the configured instructions text\n- `created_at`: ISO timestamp when the instructions were first saved\n- `updated_at`: ISO timestamp when the instructions were last updated\n- `last_updated_by`: user ID of the admin who last updated the instructions (may be `null` for older records)\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have org admin privileges required to read agent instructions. |\n\n> ###### Note:\n>\n> - Use `setAgentInstructions` to create or update agent instructions.\n> - Available from version 26.6.0.cl and later.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "AI",
- "26.6.0.cl"
- ],
- "parameters": [],
- "responses": {
- "200": {
- "description": "Common successful response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentInstructions"
- }
- }
- }
- },
- "201": {
- "description": "Common error response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentInstructions"
- }
- }
- }
- },
- "400": {
- "description": "Operation failed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized access.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden access.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "Operation failed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -489,6 +520,33 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/eureka_DataSourceSuggestionResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Data source suggestions returned",
+ "value": {
+ "data_sources": [
+ {
+ "confidence": 0.95,
+ "details": {
+ "description": "Comprehensive sales data including revenue, orders, and customers",
+ "data_source_name": "Sales Analytics",
+ "data_source_identifier": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8"
+ },
+ "reasoning": "This data source contains revenue and order data relevant to sales performance analysis"
+ },
+ {
+ "confidence": 0.82,
+ "details": {
+ "description": "Customer lifecycle and churn metrics",
+ "data_source_name": "Customer Success",
+ "data_source_identifier": "c4d5e6f7-a8b9-4c0d-e1f2-a3b4c5d6e7f8"
+ },
+ "reasoning": "Contains churn rate, retention metrics, and customer health scores"
+ }
+ ]
+ }
+ }
}
}
}
@@ -509,6 +567,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -519,6 +589,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -529,6 +611,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -539,6 +633,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -572,6 +678,23 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/eureka_GetNLInstructionsResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "NL instructions returned",
+ "value": {
+ "nl_instructions_info": [
+ {
+ "instructions": [
+ "Revenue is measured in USD thousands",
+ "When asked about 'this year', use the current fiscal year starting April",
+ "Region 'Northeast' includes NY, NJ, CT, MA, VT, NH, ME, RI"
+ ],
+ "scope": "GLOBAL"
+ }
+ ]
+ }
+ }
}
}
}
@@ -592,6 +715,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -602,6 +737,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -612,6 +759,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -622,6 +781,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -655,6 +826,30 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/eureka_GetRelevantQuestionsResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Relevant questions returned",
+ "value": {
+ "relevant_questions": [
+ {
+ "query": "What is the revenue trend by region for the last 12 months?",
+ "data_source_identifier": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "data_source_name": "Sales Analytics"
+ },
+ {
+ "query": "Which product categories have the highest conversion rate?",
+ "data_source_identifier": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "data_source_name": "Sales Analytics"
+ },
+ {
+ "query": "What is the average deal size by sales rep?",
+ "data_source_identifier": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "data_source_name": "Sales Analytics"
+ }
+ ]
+ }
+ }
}
}
}
@@ -675,8 +870,20 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
- }
- }
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"401": {
@@ -685,6 +892,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -695,6 +914,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -705,6 +936,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -739,6 +982,27 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/eureka_DecomposeQueryResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Decomposed queries returned",
+ "value": {
+ "decomposedQueryResponse": {
+ "decomposedQueries": [
+ {
+ "query": "Revenue trend in Northeast region by month",
+ "worksheetId": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "worksheetName": "Sales Analytics"
+ },
+ {
+ "query": "Top customers by revenue change in Northeast",
+ "worksheetId": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "worksheetName": "Sales Analytics"
+ }
+ ]
+ }
+ }
+ }
}
}
}
@@ -759,6 +1023,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -769,6 +1045,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -779,6 +1067,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -789,6 +1089,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -915,6 +1227,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -925,6 +1249,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -935,6 +1271,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -945,6 +1293,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1054,6 +1414,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1064,6 +1436,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1074,6 +1458,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1084,6 +1480,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1128,6 +1536,21 @@
"application/json": {
"schema": {
"type": "object"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Agent response received",
+ "value": {
+ "id": "resp-xyz789",
+ "messages": [
+ {
+ "id": "msg-001",
+ "type": "text",
+ "value": "I analyzed revenue trends for the last 6 months by product category. Here's what I found..."
+ }
+ ]
+ }
+ }
}
}
}
@@ -1148,6 +1571,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1158,6 +1593,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1168,6 +1615,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1178,6 +1637,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1212,6 +1683,15 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendAgentMessageResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Streaming message sent successfully",
+ "value": {
+ "success": true,
+ "message": "Streaming response initiated"
+ }
+ }
}
}
}
@@ -1232,6 +1712,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1242,6 +1734,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1252,6 +1756,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1262,6 +1778,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1308,6 +1836,21 @@
"items": {
"$ref": "#/components/schemas/ResponseMessage"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "AI response received",
+ "value": [
+ {
+ "session_identifier": "sess-abc123",
+ "generation_number": 1,
+ "message_type": "TSAnswer",
+ "visualization_type": "Table",
+ "tokens": "[revenue] [region] [date]",
+ "display_tokens": "Revenue by Region (Last Quarter)"
+ }
+ ]
+ }
}
}
}
@@ -1331,6 +1874,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1341,6 +1896,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1351,6 +1918,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1361,89 +1940,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/api/rest/2.0/ai/agent/instructions/set": {
- "put": {
- "operationId": "setAgentInstructions",
- "description": "\nBeta Version: 26.6.0.cl or later\n\nCreates or updates the admin instructions for the AI agent (Spotter). Admin instructions are tenant- and org-scoped text that guide agent behavior across all conversations. If instructions already exist for the org, they are replaced (upsert semantics).\n\nRequires admin privileges. Only users with org admin access can set agent instructions.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `instructions`: the instructions text to apply to the agent (maximum 5000 characters)\n\nInstructions are validated against system guardrails before being saved. If the instructions contain content that conflicts with guardrails, the request is rejected with a `409` error and the existing instructions remain unchanged.\n\nIf the request is successful, the response includes the saved `AgentInstructions` record:\n\n- `id`: unique identifier of the record\n- `instructions`: the saved instructions text\n- `created_at`: ISO timestamp when the instructions were first created\n- `updated_at`: ISO timestamp of this update\n- `last_updated_by`: user ID of the admin who performed this update\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 400 | Bad request — the request body is missing required fields or the `instructions` field exceeds the maximum allowed length of 5000 characters. |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have org admin privileges required to set agent instructions. |\n| 409 | Conflict — the provided instructions conflict with system guardrails. Review and revise the instructions text before retrying. |\n| 500 | Internal server error. |\n\n> ###### Note:\n>\n> - This operation uses upsert semantics: it creates the instructions record if none exists, or replaces the existing one.\n> - Instructions take effect immediately for new conversations created after the update.\n> - Use `getAgentInstructions` to retrieve the current instructions before making changes.\n> - Available from version 26.6.0.cl and later.\n\n\n\n\n#### Endpoint URL\n",
- "tags": [
- "AI",
- "26.6.0.cl"
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SetAgentInstructionsRequest"
- }
- }
- },
- "required": true
- },
- "parameters": [],
- "responses": {
- "200": {
- "description": "Common successful response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentInstructions"
- }
- }
- }
- },
- "201": {
- "description": "Common error response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentInstructions"
- }
- }
- }
- },
- "400": {
- "description": "Operation failed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized access.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden access.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "Operation failed",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1477,6 +1985,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/eureka_SetNLInstructionsResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "NL instructions set successfully",
+ "value": {
+ "success": true
+ }
+ }
}
}
}
@@ -1497,6 +2013,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1507,6 +2035,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1517,6 +2057,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1527,6 +2079,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1560,6 +2124,19 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseMessage"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Single answer generated successfully",
+ "value": {
+ "session_identifier": "sess-abc123",
+ "generation_number": 1,
+ "message_type": "TSAnswer",
+ "visualization_type": "Chart",
+ "tokens": "[revenue] [region] [date range] last year",
+ "display_tokens": "Total Revenue by Region (Last Year)"
+ }
+ }
}
}
}
@@ -1580,6 +2157,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1590,6 +2179,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1600,6 +2201,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1610,6 +2223,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1646,6 +2271,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1656,6 +2293,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1666,6 +2315,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1676,6 +2337,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1712,6 +2385,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1722,6 +2407,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -1732,6 +2429,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1742,6 +2451,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1765,6 +2486,28 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Returns information about the currently authenticated user",
+ "value": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "tsadmin",
+ "display_name": "TS Admin",
+ "visibility": "SHARABLE",
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "can_change_password": true,
+ "complete_detail": true,
+ "creation_time_in_millis": 1685441468684,
+ "account_type": "LOCAL_USER",
+ "account_status": "ACTIVE",
+ "email": "admin@example.com",
+ "current_org": {
+ "id": 0,
+ "name": "Primary"
+ }
+ }
+ }
}
}
}
@@ -1775,6 +2518,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1785,6 +2540,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -1795,6 +2562,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1805,6 +2584,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1828,6 +2619,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTokenResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Returns the current session token for the authenticated user",
+ "value": {
+ "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
+ "creation_time_in_millis": 1724277430000,
+ "expiration_time_in_millis": 1724277730000,
+ "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "valid_for_username": "tsadmin"
+ }
+ }
}
}
}
@@ -1838,6 +2641,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1848,6 +2663,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -1858,6 +2685,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1868,6 +2707,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1901,6 +2752,25 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessToken"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Custom access token issued successfully",
+ "value": {
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
+ "org": {
+ "id": 0,
+ "name": "Primary"
+ },
+ "user": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe"
+ },
+ "creation_time_in_millis": 1724277430000,
+ "expiration_time_in_millis": 1724277730000
+ }
+ }
}
}
}
@@ -1911,6 +2781,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1921,6 +2803,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -1931,6 +2825,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -1941,6 +2847,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -1975,6 +2893,23 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Full access token issued successfully",
+ "value": {
+ "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
+ "creation_time_in_millis": 1724277430000,
+ "expiration_time_in_millis": 1724277730000,
+ "scope": {
+ "access_type": "FULL",
+ "org_id": 0,
+ "metadata_id": null
+ },
+ "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "valid_for_username": "john_doe"
+ }
+ }
}
}
}
@@ -1985,6 +2920,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -1995,6 +2942,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2005,6 +2964,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2015,6 +2986,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2049,6 +3032,23 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Object-scoped access token issued successfully",
+ "value": {
+ "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example",
+ "creation_time_in_millis": 1724277430000,
+ "expiration_time_in_millis": 1724277730000,
+ "scope": {
+ "access_type": "REPORT_BOOK_VIEW",
+ "org_id": 0,
+ "metadata_id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f"
+ },
+ "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "valid_for_username": "john_doe"
+ }
+ }
}
}
}
@@ -2059,6 +3059,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2069,6 +3081,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2079,6 +3103,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2089,6 +3125,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2126,6 +3174,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2136,6 +3196,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2146,6 +3218,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2156,6 +3240,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2182,6 +3278,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2192,6 +3300,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2202,6 +3322,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2212,6 +3344,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2248,6 +3392,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2258,6 +3414,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2268,6 +3436,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2278,6 +3458,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2350,6 +3542,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2360,6 +3564,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2370,6 +3586,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2380,6 +3608,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2413,6 +3653,22 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenValidationResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Token is valid",
+ "value": {
+ "creation_time_in_millis": 1724277430000,
+ "expiration_time_in_millis": 1724277730000,
+ "scope": {
+ "access_type": "FULL",
+ "org_id": 0,
+ "metadata_id": null
+ },
+ "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "token_type": "JWT"
+ }
+ }
}
}
}
@@ -2423,6 +3679,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2433,6 +3701,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2443,6 +3723,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2453,6 +3745,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2486,6 +3790,31 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Collection"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Collection created successfully",
+ "value": {
+ "id": "col-a1b2c3d4-e5f6",
+ "name": "Q1 2024 Reports",
+ "description": "Collection of Q1 2024 reports",
+ "author_name": "john_doe",
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "created_at": "1724277430000",
+ "updated_at": "1724277430000",
+ "metadata": [
+ {
+ "type": "LIVEBOARD",
+ "identifiers": [
+ {
+ "identifier": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "name": "Sales Dashboard"
+ }
+ ]
+ }
+ ]
+ }
+ }
}
}
}
@@ -2496,6 +3825,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2506,6 +3847,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2516,6 +3869,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2526,6 +3891,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2559,6 +3936,25 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionDeleteResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Collections deleted (or would be deleted in dry run)",
+ "value": {
+ "metadata_deleted": [
+ {
+ "type": "COLLECTION",
+ "identifiers": [
+ {
+ "id": "col-a1b2c3d4-e5f6",
+ "name": "Q1 2024 Reports"
+ }
+ ]
+ }
+ ],
+ "metadata_skipped": []
+ }
+ }
}
}
}
@@ -2569,6 +3965,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2579,6 +3987,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2589,6 +4009,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2599,6 +4031,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Resource not found",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "The requested resource was not found."
+ }
+ }
+ }
+ }
}
}
}
@@ -2609,6 +4053,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2642,6 +4098,32 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionSearchResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all collections",
+ "value": {
+ "collections": [
+ {
+ "id": "col-a1b2c3d4-e5f6",
+ "name": "Q1 2024 Reports",
+ "description": "Collection of Q1 2024 reports",
+ "author_name": "john_doe",
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "created_at": "1724277430000",
+ "updated_at": "1724277430000",
+ "org": {
+ "identifier": "0",
+ "name": "Primary"
+ }
+ }
+ ],
+ "record_offset": 0,
+ "record_size": 10,
+ "is_last_batch": true,
+ "count": 1
+ }
+ }
}
}
}
@@ -2652,6 +4134,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2662,6 +4156,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2672,6 +4178,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2682,6 +4200,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2728,6 +4258,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2738,6 +4280,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2748,6 +4302,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2758,6 +4324,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Resource not found",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "The requested resource was not found."
+ }
+ }
+ }
+ }
}
}
}
@@ -2768,6 +4346,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2804,6 +4394,34 @@
"items": {
"$ref": "#/components/schemas/ConnectionConfigurationResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search connection configurations for a Snowflake connection",
+ "value": [
+ {
+ "configuration_identifier": "cfg-a1b2c3d4-e5f6",
+ "name": "Sales Team Config",
+ "description": "Configuration for the sales team",
+ "configuration": {
+ "warehouse": "SALES_WH",
+ "database": "SALES_DB"
+ },
+ "policy_type": "PRINCIPALS",
+ "policy_principals": [
+ {
+ "id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "name": "Sales Team",
+ "type": "USER_GROUP"
+ }
+ ],
+ "policy_processes": [],
+ "disabled": false,
+ "data_warehouse_type": "SNOWFLAKE",
+ "same_as_parent": false
+ }
+ ]
+ }
}
}
}
@@ -2814,6 +4432,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2824,6 +4454,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2834,6 +4476,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2844,6 +4498,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2877,6 +4543,31 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionConfigurationResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Connection configuration created successfully",
+ "value": {
+ "configuration_identifier": "cfg-a1b2c3d4-e5f6",
+ "name": "Sales Team Config",
+ "description": "Configuration for the sales team",
+ "configuration": {
+ "warehouse": "SALES_WH",
+ "database": "SALES_DB"
+ },
+ "policy_type": "PRINCIPALS",
+ "policy_principals": [
+ {
+ "id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "name": "Sales Team",
+ "type": "USER_GROUP"
+ }
+ ],
+ "disabled": false,
+ "data_warehouse_type": "SNOWFLAKE",
+ "same_as_parent": false
+ }
+ }
}
}
}
@@ -2887,6 +4578,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2897,6 +4600,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2907,6 +4622,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2917,6 +4644,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -2953,6 +4692,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -2963,6 +4714,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -2973,6 +4736,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -2983,6 +4758,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3029,6 +4816,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3039,6 +4838,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3049,6 +4860,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3059,6 +4882,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3092,6 +4927,21 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateConnectionResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Connection created successfully",
+ "value": {
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "name": "Production Snowflake",
+ "data_warehouse_type": "SNOWFLAKE",
+ "details": {
+ "accountName": "my-account.snowflakecomputing.com",
+ "warehouse": "COMPUTE_WH",
+ "database": "PROD_DB"
+ }
+ }
+ }
}
}
}
@@ -3102,6 +4952,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3112,6 +4974,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3122,6 +4996,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3132,6 +5018,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3169,6 +5067,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3179,6 +5089,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3189,6 +5111,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3199,6 +5133,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3235,6 +5181,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3245,6 +5203,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3255,6 +5225,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3265,6 +5247,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3304,6 +5298,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3314,6 +5320,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3324,6 +5342,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3334,6 +5364,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3367,6 +5409,20 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchConnectionDiffStatusResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Connection has schema differences",
+ "value": {
+ "status": true
+ }
+ },
+ "example_2": {
+ "description": "No schema differences detected",
+ "value": {
+ "status": false
+ }
+ }
}
}
}
@@ -3377,6 +5433,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3387,6 +5455,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3397,6 +5477,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3407,6 +5499,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3450,6 +5554,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevokeRefreshTokensResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Refresh tokens revoked successfully",
+ "value": {
+ "data": "Refresh tokens revoked successfully for 5 users"
+ }
+ }
}
}
}
@@ -3460,6 +5572,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3470,6 +5594,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3480,6 +5616,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3490,6 +5638,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Resource not found",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "The requested resource was not found."
+ }
+ }
+ }
+ }
}
}
}
@@ -3500,6 +5660,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Conflict",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Operation failed due to a conflict with the current state of the resource."
+ }
+ }
+ }
+ }
}
}
}
@@ -3510,6 +5682,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3546,6 +5730,48 @@
"items": {
"$ref": "#/components/schemas/SearchConnectionResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all Snowflake connections",
+ "value": [
+ {
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "name": "Production Snowflake",
+ "description": "Main production Snowflake connection",
+ "data_warehouse_type": "SNOWFLAKE",
+ "data_warehouse_objects": {
+ "databases": [
+ {
+ "name": "PROD_DB",
+ "schemas": [
+ {
+ "name": "PUBLIC",
+ "tables": [
+ {
+ "name": "SALES_FACT",
+ "columns": [
+ {
+ "name": "SALE_ID",
+ "data_type": "NUMBER",
+ "selected": true
+ },
+ {
+ "name": "AMOUNT",
+ "data_type": "FLOAT",
+ "selected": true
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
}
}
}
@@ -3556,6 +5782,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3566,6 +5804,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3576,6 +5826,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3586,6 +5848,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3629,6 +5903,30 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncMetadataResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Metadata sync completed successfully",
+ "value": {
+ "status": "SUCCESS",
+ "tables_updated": 5,
+ "columns_updated": 42,
+ "tables_failed": 0,
+ "columns_failed": 0,
+ "message": "Metadata sync completed successfully"
+ }
+ },
+ "example_2": {
+ "description": "Partial metadata sync success",
+ "value": {
+ "status": "PARTIAL_SUCCESS",
+ "tables_updated": 3,
+ "columns_updated": 28,
+ "tables_failed": 2,
+ "columns_failed": 14,
+ "message": "Some tables failed to sync"
+ }
+ }
}
}
}
@@ -3639,6 +5937,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3649,6 +5959,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3659,6 +5981,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3669,6 +6003,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Resource not found",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "The requested resource was not found."
+ }
+ }
+ }
+ }
}
}
}
@@ -3679,6 +6025,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3716,6 +6074,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3726,6 +6096,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3736,6 +6118,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3746,6 +6140,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3792,6 +6198,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3802,6 +6220,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3812,6 +6242,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3822,6 +6264,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Resource not found",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "The requested resource was not found."
+ }
+ }
+ }
+ }
}
}
}
@@ -3832,6 +6286,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3878,6 +6344,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3888,6 +6366,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3898,6 +6388,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3908,6 +6410,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -3969,6 +6483,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -3979,6 +6505,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -3989,6 +6527,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -3999,6 +6549,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4035,6 +6597,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4045,6 +6619,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4055,6 +6641,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4065,6 +6663,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4129,6 +6739,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4139,6 +6761,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4149,6 +6783,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4159,6 +6805,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4205,6 +6863,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4215,6 +6885,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4225,6 +6907,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4235,6 +6929,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4268,6 +6974,20 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Custom calendar created successfully",
+ "value": {
+ "calendar_id": "cal-a1b2c3d4-e5f6",
+ "calendar_name": "Fiscal Year 2024",
+ "connection_name": "Production Snowflake",
+ "data_warehouse_type": "SNOWFLAKE",
+ "modification_time_in_millis": "1724277430000",
+ "author_name": "john_doe",
+ "connection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+ }
+ }
}
}
}
@@ -4278,6 +6998,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4288,6 +7020,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4298,6 +7042,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4308,6 +7064,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4344,6 +7112,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4354,6 +7134,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4364,6 +7156,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4374,6 +7178,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4417,6 +7233,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4427,6 +7255,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4437,6 +7277,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4447,6 +7299,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4483,6 +7347,22 @@
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all custom calendars",
+ "value": [
+ {
+ "calendar_id": "cal-a1b2c3d4-e5f6",
+ "calendar_name": "Fiscal Year 2024",
+ "connection_name": "Production Snowflake",
+ "data_warehouse_type": "SNOWFLAKE",
+ "modification_time_in_millis": "1724277430000",
+ "author_name": "john_doe",
+ "connection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+ }
+ ]
+ }
}
}
}
@@ -4493,6 +7373,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4503,6 +7395,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4513,6 +7417,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4523,6 +7439,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4569,6 +7497,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4579,6 +7519,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4589,6 +7541,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4599,6 +7563,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4632,6 +7608,42 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnswerDataResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Answer data returned successfully",
+ "value": {
+ "metadata_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "metadata_name": "Revenue Analysis",
+ "contents": [
+ {
+ "column_names": [
+ "Region",
+ "Revenue"
+ ],
+ "data_rows": [
+ [
+ "Northeast",
+ 1250000
+ ],
+ [
+ "Southeast",
+ 890000
+ ],
+ [
+ "West",
+ 1050000
+ ]
+ ],
+ "available_data_row_count": 3,
+ "returned_data_row_count": 3,
+ "record_offset": 0,
+ "record_size": 100,
+ "sampling_ratio": 1
+ }
+ ]
+ }
+ }
}
}
}
@@ -4642,6 +7654,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4652,6 +7676,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4662,6 +7698,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4672,6 +7720,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4705,6 +7765,63 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiveboardDataResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Liveboard data returned successfully",
+ "value": {
+ "metadata_id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "metadata_name": "Sales Dashboard",
+ "contents": [
+ {
+ "visualization_id": "viz-001",
+ "visualization_name": "Revenue by Region",
+ "column_names": [
+ "Region",
+ "Total Revenue"
+ ],
+ "data_rows": [
+ [
+ "Northeast",
+ 1250000
+ ],
+ [
+ "West",
+ 1050000
+ ]
+ ],
+ "available_data_row_count": 2,
+ "returned_data_row_count": 2,
+ "record_offset": 0,
+ "record_size": 100,
+ "sampling_ratio": 1
+ },
+ {
+ "visualization_id": "viz-002",
+ "visualization_name": "Monthly Trend",
+ "column_names": [
+ "Month",
+ "Revenue"
+ ],
+ "data_rows": [
+ [
+ "January",
+ 420000
+ ],
+ [
+ "February",
+ 385000
+ ]
+ ],
+ "available_data_row_count": 12,
+ "returned_data_row_count": 2,
+ "record_offset": 0,
+ "record_size": 100,
+ "sampling_ratio": 1
+ }
+ ]
+ }
+ }
}
}
}
@@ -4715,6 +7832,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4725,6 +7854,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4735,6 +7876,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4745,6 +7898,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4778,6 +7943,40 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchDataResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search query results returned",
+ "value": {
+ "contents": [
+ {
+ "column_names": [
+ "Region",
+ "Total Sales"
+ ],
+ "data_rows": [
+ [
+ "Northeast",
+ 5250000
+ ],
+ [
+ "Southeast",
+ 3890000
+ ],
+ [
+ "West",
+ 4050000
+ ]
+ ],
+ "available_data_row_count": 3,
+ "returned_data_row_count": 3,
+ "record_offset": 0,
+ "record_size": 50,
+ "sampling_ratio": 1
+ }
+ ]
+ }
+ }
}
}
}
@@ -4788,6 +7987,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4798,6 +8009,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4808,6 +8031,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4818,6 +8053,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4903,6 +8150,18 @@
"application/json": {
"schema": {
"type": "object"
+ },
+ "examples": {
+ "example_1": {
+ "description": "dbt connection created successfully",
+ "value": {
+ "dbt_connection_identifier": "dbt-a1b2c3d4-e5f6",
+ "project_name": "my-dbt-project",
+ "connection_name": "Production Snowflake",
+ "cdw_database": "ANALYTICS",
+ "import_type": "DBT_CLOUD"
+ }
+ }
}
}
}
@@ -4913,6 +8172,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -4923,6 +8194,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -4933,6 +8216,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -4943,6 +8238,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -4990,6 +8297,16 @@
"application/json": {
"schema": {
"type": "object"
+ },
+ "examples": {
+ "example_1": {
+ "description": "dbt TML sync completed successfully",
+ "value": {
+ "status": "SUCCESS",
+ "synced_models": 5,
+ "failed_models": 0
+ }
+ }
}
}
}
@@ -5000,6 +8317,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5010,6 +8339,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5020,6 +8361,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5030,6 +8383,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5098,6 +8463,20 @@
"application/json": {
"schema": {
"type": "object"
+ },
+ "examples": {
+ "example_1": {
+ "description": "TML generated from dbt models",
+ "value": {
+ "status": "SUCCESS",
+ "generated_tml": [
+ {
+ "model_name": "stg_orders",
+ "tml": "{\"worksheet\":{\"name\":\"stg_orders\"}}"
+ }
+ ]
+ }
+ }
}
}
}
@@ -5108,6 +8487,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5118,6 +8509,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5128,6 +8531,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5138,6 +8553,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5164,6 +8591,22 @@
"items": {
"$ref": "#/components/schemas/DbtSearchResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "List all dbt connections",
+ "value": [
+ {
+ "dbt_connection_identifier": "dbt-a1b2c3d4-e5f6",
+ "project_name": "my-dbt-project",
+ "connection_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "connection_name": "Production Snowflake",
+ "cdw_database": "ANALYTICS",
+ "import_type": "DBT_CLOUD",
+ "author_name": "john_doe"
+ }
+ ]
+ }
}
}
}
@@ -5174,6 +8617,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5184,6 +8639,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5194,6 +8661,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5204,6 +8683,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5240,6 +8731,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5250,6 +8753,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5260,6 +8775,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5270,6 +8797,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5368,6 +8907,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5378,6 +8929,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5388,6 +8951,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5398,6 +8973,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5431,6 +9018,24 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEmailCustomizationResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Email customization created successfully",
+ "value": {
+ "tenant_id": "tenant-abc123",
+ "org": {
+ "name": "Primary",
+ "id": 0
+ },
+ "name": "Primary Email Customization",
+ "template_properties": {
+ "product_name": "MyAnalytics",
+ "primary_bg_color": "#1a73e8",
+ "logo_url": "https://cdn.example.com/logo.png"
+ }
+ }
+ }
}
}
}
@@ -5441,6 +9046,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5451,6 +9068,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5461,6 +9090,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5498,6 +9139,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5508,6 +9161,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5518,6 +9183,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5554,6 +9231,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5564,6 +9253,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5574,6 +9275,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5584,6 +9297,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5620,6 +9345,32 @@
"items": {
"$ref": "#/components/schemas/CreateEmailCustomizationResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Get email customization for all orgs",
+ "value": [
+ {
+ "tenant_id": "tenant-abc123",
+ "org": {
+ "name": "Primary",
+ "id": 0
+ },
+ "name": "Primary Email Customization",
+ "template_properties": {
+ "product_name": "MyAnalytics",
+ "primary_bg_color": "#1a73e8",
+ "cta_button_bg_color": "#1a73e8",
+ "cta_text_font_color": "#ffffff",
+ "home_url": "https://analytics.example.com",
+ "logo_url": "https://cdn.example.com/logo.png",
+ "font_family": "Arial, sans-serif",
+ "footer_address": "123 Main St, San Francisco, CA",
+ "hide_privacy_policy": false
+ }
+ }
+ ]
+ }
}
}
}
@@ -5630,6 +9381,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5640,6 +9403,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5650,6 +9425,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5686,6 +9473,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5696,6 +9495,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5706,6 +9517,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5716,6 +9539,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5742,6 +9577,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5752,6 +9599,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5762,6 +9621,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5795,6 +9666,37 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGroupResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "User group created successfully",
+ "value": {
+ "id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "name": "Sales Team",
+ "display_name": "Sales Team",
+ "description": "Group for all sales personnel",
+ "type": "LOCAL_GROUP",
+ "visibility": "SHARABLE",
+ "privileges": [
+ "DATADOWNLOADING"
+ ],
+ "users": [
+ {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe"
+ },
+ {
+ "id": "7f5e7f87-09a1-487c-a1da-c4bb35e45270",
+ "name": "jane_smith"
+ }
+ ],
+ "sub_groups": [],
+ "creation_time_in_millis": 1724277430000,
+ "modification_time_in_millis": 1724277430000,
+ "system_group": false,
+ "deleted": false
+ }
+ }
}
}
}
@@ -5805,6 +9707,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5815,6 +9729,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5825,6 +9751,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5835,6 +9773,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5871,6 +9821,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5881,6 +9843,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5891,6 +9865,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5901,6 +9887,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -5934,6 +9932,21 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportUserGroupsResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Dry run result showing groups that would be modified",
+ "value": {
+ "groups_added": [
+ {
+ "id": "new-group-guid-1",
+ "name": "sales-team"
+ }
+ ],
+ "groups_deleted": [],
+ "groups_updated": []
+ }
+ }
}
}
}
@@ -5944,6 +9957,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -5954,6 +9979,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -5964,6 +10001,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -5974,6 +10023,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6010,6 +10071,59 @@
"items": {
"$ref": "#/components/schemas/UserGroupResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all user groups",
+ "value": [
+ {
+ "id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "name": "Sales Team",
+ "display_name": "Sales Team",
+ "description": "Group for all sales personnel",
+ "type": "LOCAL_GROUP",
+ "visibility": "SHARABLE",
+ "privileges": [
+ "DATADOWNLOADING"
+ ],
+ "users": [
+ {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe"
+ }
+ ],
+ "sub_groups": [],
+ "orgs": [
+ {
+ "id": "0",
+ "name": "Primary"
+ }
+ ],
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1685441468684,
+ "system_group": false,
+ "deleted": false
+ },
+ {
+ "id": "c36ff495-ae24-5ae4-a496-de08a6c364c5",
+ "name": "Analytics Users",
+ "display_name": "Analytics Users",
+ "description": "Group for analytics team",
+ "type": "LOCAL_GROUP",
+ "visibility": "SHARABLE",
+ "privileges": [
+ "DATADOWNLOADING",
+ "USERDATAUPLOADING"
+ ],
+ "users": [],
+ "sub_groups": [],
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1685441468684,
+ "system_group": false,
+ "deleted": false
+ }
+ ]
+ }
}
}
}
@@ -6020,6 +10134,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6030,6 +10156,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6040,6 +10178,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6050,6 +10200,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6096,6 +10258,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6106,6 +10280,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6116,6 +10302,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6126,6 +10324,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6248,6 +10458,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6258,6 +10480,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6268,6 +10502,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6278,6 +10524,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6314,6 +10572,25 @@
"items": {
"$ref": "#/components/schemas/LogResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Security audit logs returned",
+ "value": [
+ {
+ "date": "2024-08-21T12:30:00Z",
+ "log": "{\"type\":\"LOGIN\",\"user\":\"john_doe\",\"ip\":\"192.168.1.100\",\"status\":\"SUCCESS\"}"
+ },
+ {
+ "date": "2024-08-21T12:35:00Z",
+ "log": "{\"type\":\"OBJECT_SHARE\",\"user\":\"jane_smith\",\"object_id\":\"2ff57a24-cf90-485f-8b4b-45fc17474c6f\",\"recipient\":\"Sales Team\"}"
+ },
+ {
+ "date": "2024-08-21T12:40:00Z",
+ "log": "{\"type\":\"LOGOUT\",\"user\":\"john_doe\",\"ip\":\"192.168.1.100\"}"
+ }
+ ]
+ }
}
}
}
@@ -6324,6 +10601,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6334,6 +10623,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6344,6 +10645,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6354,6 +10667,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6387,6 +10712,36 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseWorksheetToModelConversion"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Worksheet conversion result",
+ "value": {
+ "name": "WorksheetToModelConversion",
+ "success_count": 1,
+ "failure_count": 0,
+ "incomplete_count": 0,
+ "post_upgrade_failed_count": 0,
+ "total_time_in_millis": 1250,
+ "successful_entities": {
+ "data": [
+ {
+ "id": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "name": "Sales Analytics"
+ }
+ ]
+ },
+ "failed_entities": {
+ "data": []
+ },
+ "incomplete_entities": {
+ "data": []
+ },
+ "post_upgrade_failed_entities": {
+ "data": []
+ }
+ }
+ }
}
}
}
@@ -6397,6 +10752,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6407,6 +10774,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6417,6 +10796,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6427,6 +10818,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6460,6 +10863,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseCopyObject"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Object copied successfully",
+ "value": {
+ "metadata_id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a"
+ }
+ }
}
}
}
@@ -6470,6 +10881,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6480,6 +10903,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6490,6 +10925,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6500,6 +10947,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Resource not found",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "The requested resource was not found."
+ }
+ }
+ }
+ }
}
}
}
@@ -6510,6 +10969,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6546,6 +11017,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6556,6 +11039,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6566,6 +11061,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6576,6 +11083,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6612,6 +11131,17 @@
"items": {
"type": "object"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "TML exported successfully",
+ "value": [
+ {
+ "guid": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "edoc": "{\"liveboard\":{\"name\":\"Sales Dashboard\",\"visualizations\":[]}}"
+ }
+ ]
+ }
}
}
}
@@ -6622,6 +11152,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6632,6 +11174,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6642,6 +11196,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6652,6 +11218,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6685,6 +11263,22 @@
"application/json": {
"schema": {
"type": "object"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Batch TML export result",
+ "value": {
+ "batch_offset": 0,
+ "batch_size": 20,
+ "total_count": 45,
+ "objects": [
+ {
+ "guid": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "edoc": "{\"user\":{\"name\":\"john_doe\",\"display_name\":\"John Doe\"}}"
+ }
+ ]
+ }
+ }
}
}
}
@@ -6695,6 +11289,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6705,6 +11311,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6715,6 +11333,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6725,6 +11355,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6758,6 +11400,23 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SqlQueryResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "SQL query generated for an Answer",
+ "value": {
+ "metadata_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "metadata_name": "Revenue Analysis",
+ "metadata_type": "ANSWER",
+ "sql_queries": [
+ {
+ "metadata_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "metadata_name": "Revenue Analysis",
+ "sql_query": "SELECT SUM(revenue) as total_revenue, region FROM sales_fact GROUP BY region ORDER BY total_revenue DESC LIMIT 100"
+ }
+ ]
+ }
+ }
}
}
}
@@ -6768,6 +11427,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6778,6 +11449,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6788,6 +11471,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6798,6 +11493,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6831,6 +11538,47 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAsyncImportStatusResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Async import task completed",
+ "value": {
+ "status_list": [
+ {
+ "tenant_id": "tenant-abc123",
+ "org_id": 0,
+ "task_id": "task-abc123-def456",
+ "task_name": "TML Import - Sales Dashboard",
+ "task_status": "COMPLETED",
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "author_display_name": "Administrator",
+ "import_policy": "PARTIAL",
+ "created_at": 1724277000000,
+ "in_progress_at": 1724277010000,
+ "completed_at": 1724277030000,
+ "modified_at": 1724277030000,
+ "total_object_count": 2,
+ "object_processed_count": 2,
+ "import_response": null
+ }
+ ],
+ "last_batch": true
+ }
+ },
+ "example_2": {
+ "description": "Async import task in progress",
+ "value": {
+ "status_list": [
+ {
+ "task_id": "task-abc123-def456",
+ "task_status": "IN_PROGRESS",
+ "total_object_count": 5,
+ "object_processed_count": 2
+ }
+ ],
+ "last_batch": true
+ }
+ }
}
}
}
@@ -6841,6 +11589,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6851,6 +11611,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6861,6 +11633,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6871,6 +11655,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6904,6 +11700,28 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SqlQueryResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "SQL queries for all visualizations in a Liveboard",
+ "value": {
+ "metadata_id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "metadata_name": "Sales Dashboard",
+ "metadata_type": "LIVEBOARD",
+ "sql_queries": [
+ {
+ "metadata_id": "viz-001",
+ "metadata_name": "Revenue by Region",
+ "sql_query": "SELECT SUM(revenue) as total_revenue, region FROM sales_fact GROUP BY region"
+ },
+ {
+ "metadata_id": "viz-002",
+ "metadata_name": "Orders by Category",
+ "sql_query": "SELECT product_category, COUNT(*) as order_count FROM orders GROUP BY product_category"
+ }
+ ]
+ }
+ }
}
}
}
@@ -6914,6 +11732,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -6924,6 +11754,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -6934,6 +11776,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -6944,6 +11798,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -6980,6 +11846,27 @@
"items": {
"type": "object"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "TML imported successfully",
+ "value": [
+ {
+ "response": {
+ "status": {
+ "status_code": "OK"
+ },
+ "object": [
+ {
+ "id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "name": "Sales Dashboard",
+ "type": "LIVEBOARD"
+ }
+ ]
+ }
+ }
+ ]
+ }
}
}
}
@@ -6990,6 +11877,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7000,6 +11899,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7010,6 +11921,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7020,6 +11943,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7053,6 +11988,24 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportEPackAsyncTaskStatus"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Async import task created",
+ "value": {
+ "tenant_id": "tenant-abc123",
+ "org_id": 0,
+ "task_id": "task-abc123-def456",
+ "task_name": "TML Async Import",
+ "task_status": "IN_QUEUE",
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "author_display_name": "Administrator",
+ "import_policy": "PARTIAL_OBJECT",
+ "created_at": 1724277000000,
+ "total_object_count": 2,
+ "object_processed_count": 0
+ }
+ }
}
}
}
@@ -7063,6 +12016,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7073,6 +12038,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7083,6 +12060,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7093,6 +12082,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7130,6 +12131,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7140,6 +12153,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7150,6 +12175,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7160,6 +12197,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7196,6 +12245,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7206,6 +12267,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7216,6 +12289,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7226,6 +12311,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7262,6 +12359,202 @@
"items": {
"$ref": "#/components/schemas/MetadataSearchResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Liveboards with metadata headers (default)",
+ "value": [
+ {
+ "metadata_id": "4145513c-c9bd-4e48-af44-8dc001b5f955",
+ "metadata_name": "Sales Dashboard",
+ "metadata_type": "LIVEBOARD",
+ "metadata_obj_id": "SalesDashboard-4145513c",
+ "dependent_objects": null,
+ "incomplete_objects": null,
+ "metadata_detail": null,
+ "metadata_header": {
+ "id": "4145513c-c9bd-4e48-af44-8dc001b5f955",
+ "name": "Sales Dashboard",
+ "description": "Monthly sales performance dashboard",
+ "author": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "authorName": "tsadmin",
+ "authorDisplayName": "Administrator",
+ "created": 1640112926087,
+ "modified": 1724277430000,
+ "modifiedBy": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "owner": "4145513c-c9bd-4e48-af44-8dc001b5f955",
+ "isDeleted": false,
+ "isHidden": false,
+ "isAutoCreated": false,
+ "isAutoDelete": false,
+ "isExternal": false,
+ "isDeprecated": false,
+ "isSharedViaConnection": false,
+ "isVerified": false,
+ "isVersioningEnabled": false,
+ "isPublished": false,
+ "hasTabs": false,
+ "modelVersion": "V2",
+ "hasMandatoryFilter": false,
+ "isMandatoryFilterValueSelected": true,
+ "totalContainerCount": 6,
+ "indexVersion": 2903279,
+ "generationNum": 4175059,
+ "orgIds": [
+ 0
+ ],
+ "ownerOrgId": 0,
+ "objId": "SalesDashboard-4145513c",
+ "tags": [
+ {
+ "id": "ea0fa175-f387-4d9e-97b6-e79c4b4d82b2",
+ "name": "finance",
+ "clientState": {
+ "color": "#c2d578"
+ },
+ "isDeleted": false,
+ "isHidden": false
+ }
+ ],
+ "aiAnswerGenerationDisabled": false,
+ "syncWithSource": false,
+ "csrProtected": false,
+ "resolvedObjects": {}
+ },
+ "visualization_headers": null,
+ "stats": null
+ },
+ {
+ "metadata_id": "9b815531-ccb0-480e-b0fa-85e036d7377f",
+ "metadata_name": "Revenue Analysis",
+ "metadata_type": "LIVEBOARD",
+ "metadata_obj_id": "RevenueAnalysis-9b815531",
+ "dependent_objects": null,
+ "incomplete_objects": null,
+ "metadata_detail": null,
+ "metadata_header": {
+ "id": "9b815531-ccb0-480e-b0fa-85e036d7377f",
+ "name": "Revenue Analysis",
+ "description": "",
+ "author": "7f5e7f87-09a1-487c-a1da-c4bb35e45270",
+ "authorName": "jane_smith",
+ "authorDisplayName": "Jane Smith",
+ "created": 1641226956140,
+ "modified": 1641226956140,
+ "modifiedBy": "7f5e7f87-09a1-487c-a1da-c4bb35e45270",
+ "owner": "9b815531-ccb0-480e-b0fa-85e036d7377f",
+ "isDeleted": false,
+ "isHidden": false,
+ "isAutoCreated": false,
+ "isAutoDelete": false,
+ "isExternal": false,
+ "isDeprecated": false,
+ "isSharedViaConnection": false,
+ "isVerified": false,
+ "isVersioningEnabled": false,
+ "isPublished": false,
+ "hasTabs": true,
+ "modelVersion": "V2",
+ "hasMandatoryFilter": false,
+ "isMandatoryFilterValueSelected": true,
+ "totalContainerCount": 5,
+ "indexVersion": 302968,
+ "generationNum": 4175270,
+ "orgIds": [
+ 0
+ ],
+ "ownerOrgId": 0,
+ "objId": "RevenueAnalysis-9b815531",
+ "tags": [],
+ "aiAnswerGenerationDisabled": false,
+ "syncWithSource": false,
+ "csrProtected": false,
+ "resolvedObjects": {}
+ },
+ "visualization_headers": null,
+ "stats": null
+ }
+ ]
+ },
+ "example_2": {
+ "description": "Worksheets with stats and dependent objects",
+ "value": [
+ {
+ "metadata_id": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "metadata_name": "Sales Analytics",
+ "metadata_type": "LOGICAL_TABLE",
+ "metadata_obj_id": "SalesAnalytics-b3e4f5a6",
+ "dependent_objects": {
+ "dependents": [
+ {
+ "id": "4145513c-c9bd-4e48-af44-8dc001b5f955",
+ "name": "Sales Dashboard",
+ "type": "PINBOARD_ANSWER_BOOK"
+ }
+ ],
+ "total_count": 1
+ },
+ "incomplete_objects": null,
+ "metadata_detail": null,
+ "metadata_header": {
+ "id": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "name": "Sales Analytics",
+ "description": "Comprehensive sales worksheet",
+ "author": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "authorName": "tsadmin",
+ "authorDisplayName": "Administrator",
+ "created": 1640112926087,
+ "modified": 1724277430000,
+ "modifiedBy": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "owner": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "isDeleted": false,
+ "isHidden": false,
+ "isAutoCreated": false,
+ "isAutoDelete": false,
+ "isExternal": false,
+ "isDeprecated": false,
+ "isSharedViaConnection": false,
+ "isVerified": false,
+ "isVersioningEnabled": false,
+ "isPublished": false,
+ "indexVersion": 2903279,
+ "generationNum": 4175059,
+ "orgIds": [
+ 0
+ ],
+ "ownerOrgId": 0,
+ "tags": [],
+ "aiAnswerGenerationDisabled": false,
+ "syncWithSource": false,
+ "csrProtected": false,
+ "resolvedObjects": {}
+ },
+ "visualization_headers": null,
+ "stats": {
+ "views": 1250,
+ "favorites": 34,
+ "last_accessed": 1724277430000
+ }
+ }
+ ]
+ },
+ "example_3": {
+ "description": "Answers without headers (minimal response)",
+ "value": [
+ {
+ "metadata_id": "c4d5e6f7-a8b9-4c0d-e1f2-a3b4c5d6e7f8",
+ "metadata_name": "Monthly Revenue by Region",
+ "metadata_type": "ANSWER",
+ "metadata_obj_id": null,
+ "dependent_objects": null,
+ "incomplete_objects": null,
+ "metadata_detail": null,
+ "metadata_header": null,
+ "visualization_headers": null,
+ "stats": null
+ }
+ ]
+ }
}
}
}
@@ -7272,6 +12565,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7282,6 +12587,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7292,6 +12609,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7302,6 +12631,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7338,6 +12679,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7348,6 +12701,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7358,6 +12723,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7368,6 +12745,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7404,6 +12793,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7414,6 +12815,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7424,6 +12837,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7434,6 +12859,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7470,6 +12907,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7480,6 +12929,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7490,6 +12951,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7500,6 +12973,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7536,6 +13021,7 @@
},
"examples": {
"example_1": {
+ "description": "Org created successfully",
"value": {
"id": 1980035173,
"name": "test_org",
@@ -7554,6 +13040,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7564,6 +13062,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7574,6 +13084,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7584,6 +13106,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7620,6 +13154,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7630,6 +13176,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7640,6 +13198,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7650,6 +13220,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7716,6 +13298,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7726,6 +13320,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7736,6 +13342,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7746,6 +13364,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7792,6 +13422,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7802,6 +13444,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7812,6 +13466,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7822,6 +13488,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7861,6 +13539,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7871,6 +13561,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7881,6 +13583,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7891,6 +13605,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7930,6 +13656,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -7940,6 +13678,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -7950,6 +13700,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -7960,6 +13722,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -7993,6 +13767,32 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Role created successfully",
+ "value": {
+ "id": "d3f8c4a2-6b9e-4d7f-a1c3-8e5b2f7d4a9c",
+ "name": "Data Analyst",
+ "description": "Role for data analysts with download and search permissions",
+ "privileges": [
+ "DATADOWNLOADING",
+ "USERDATAUPLOADING"
+ ],
+ "groups_assigned_count": 0,
+ "groups": [],
+ "orgs": [
+ {
+ "id": "0",
+ "name": "Primary"
+ }
+ ],
+ "creation_time_in_millis": 1724277430000,
+ "modification_time_in_millis": 1724277430000,
+ "deleted": false,
+ "deprecated": false
+ }
+ }
}
}
}
@@ -8003,6 +13803,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8013,6 +13825,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8023,6 +13847,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8033,6 +13869,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8069,6 +13917,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8079,6 +13939,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8089,6 +13961,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8099,6 +13983,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8135,6 +14031,39 @@
"items": {
"$ref": "#/components/schemas/SearchRoleResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all roles",
+ "value": [
+ {
+ "id": "d3f8c4a2-6b9e-4d7f-a1c3-8e5b2f7d4a9c",
+ "name": "Data Analyst",
+ "description": "Role for data analysts with download and search permissions",
+ "privileges": [
+ "DATADOWNLOADING",
+ "USERDATAUPLOADING"
+ ],
+ "groups_assigned_count": 2,
+ "groups": [
+ {
+ "id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "name": "Analytics Users"
+ }
+ ],
+ "orgs": [
+ {
+ "id": "0",
+ "name": "Primary"
+ }
+ ],
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1685441468684,
+ "deleted": false,
+ "deprecated": false
+ }
+ ]
+ }
}
}
}
@@ -8145,6 +14074,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8155,6 +14096,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8165,6 +14118,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8175,6 +14140,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8218,6 +14195,25 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Role updated successfully",
+ "value": {
+ "id": "d3f8c4a2-6b9e-4d7f-a1c3-8e5b2f7d4a9c",
+ "name": "Senior Data Analyst",
+ "description": "Role for senior data analysts with extended permissions",
+ "privileges": [
+ "DATADOWNLOADING",
+ "USERDATAUPLOADING",
+ "A3ANALYSIS"
+ ],
+ "groups_assigned_count": 2,
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1724277430000,
+ "deleted": false
+ }
+ }
}
}
}
@@ -8228,6 +14224,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8238,6 +14246,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8248,6 +14268,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8258,6 +14290,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8291,6 +14335,55 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseSchedule"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Schedule created successfully",
+ "value": {
+ "id": "sch-a1b2c3d4-e5f6",
+ "name": "Weekly Sales Report",
+ "description": "Weekly PDF report for the sales team",
+ "file_format": "PDF",
+ "status": "ACTIVE",
+ "time_zone": "America/New_York",
+ "frequency": {
+ "cron_expression": {
+ "day_of_month": "?",
+ "day_of_week": "MON",
+ "hour": "8",
+ "minute": "0",
+ "month": "*",
+ "second": "0"
+ }
+ },
+ "metadata": {
+ "id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "name": "Sales Dashboard",
+ "type": "LIVEBOARD"
+ },
+ "recipient_details": {
+ "emails": [
+ "sales@example.com"
+ ],
+ "principals": [
+ {
+ "identifier": "Sales Team",
+ "type": "USER_GROUP"
+ }
+ ]
+ },
+ "pdf_options": {
+ "include_cover_page": true,
+ "page_orientation": "LANDSCAPE",
+ "page_size": "A4"
+ },
+ "author": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe"
+ },
+ "creation_time_in_millis": 1724277430000
+ }
+ }
}
}
}
@@ -8301,6 +14394,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8311,6 +14416,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8321,6 +14438,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8331,6 +14460,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8367,6 +14508,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8377,6 +14530,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8387,6 +14552,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8397,6 +14574,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8433,6 +14622,52 @@
"items": {
"$ref": "#/components/schemas/ResponseSchedule"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all active schedules",
+ "value": [
+ {
+ "id": "sch-a1b2c3d4-e5f6",
+ "name": "Weekly Sales Report",
+ "description": "Weekly PDF report for the sales team",
+ "file_format": "PDF",
+ "frequency": {
+ "cron_expression": {
+ "day_of_month": "?",
+ "day_of_week": "MON",
+ "hour": "8",
+ "minute": "0",
+ "month": "*",
+ "second": "0"
+ }
+ },
+ "metadata": {
+ "id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f",
+ "name": "Sales Dashboard",
+ "type": "LIVEBOARD"
+ },
+ "recipient_details": {
+ "emails": [
+ "sales@example.com"
+ ],
+ "principals": [
+ {
+ "identifier": "Sales Team",
+ "type": "USER_GROUP"
+ }
+ ]
+ },
+ "status": "ACTIVE",
+ "time_zone": "America/New_York",
+ "author": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe"
+ },
+ "creation_time_in_millis": 1685441468684
+ }
+ ]
+ }
}
}
}
@@ -8443,6 +14678,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8453,6 +14700,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8463,6 +14722,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8473,6 +14744,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8519,6 +14802,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8529,6 +14824,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8539,6 +14846,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8549,6 +14868,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8585,6 +14916,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8595,6 +14938,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8605,6 +14960,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8615,6 +14982,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8651,6 +15030,51 @@
"items": {
"$ref": "#/components/schemas/ColumnSecurityRuleResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Column security rules for a table",
+ "value": [
+ {
+ "table_guid": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "obj_id": "SALES_FACT",
+ "column_security_rules": [
+ {
+ "column": {
+ "id": "col-a1b2c3d4-e5f6",
+ "name": "SALARY"
+ },
+ "groups": [
+ {
+ "id": "b25ee394-9d13-49e3-9385-cd97f5b253b4",
+ "name": "HR Team"
+ }
+ ],
+ "source_table_details": {
+ "id": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "name": "SALES_FACT"
+ }
+ },
+ {
+ "column": {
+ "id": "col-b2c3d4e5-f6a7",
+ "name": "SSN"
+ },
+ "groups": [
+ {
+ "id": "c36ff495-ae24-5ae4-a496-de08a6c364c5",
+ "name": "Admin Group"
+ }
+ ],
+ "source_table_details": {
+ "id": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "name": "SALES_FACT"
+ }
+ }
+ ]
+ }
+ ]
+ }
}
}
}
@@ -8661,6 +15085,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8671,6 +15107,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8681,6 +15129,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8691,6 +15151,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8724,6 +15196,31 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPrivilegesOfMetadataResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Fetch object privileges for a logical table",
+ "value": {
+ "metadata_object_privileges": {
+ "metadata_privilege_details": [
+ {
+ "metadata_id": "b3e4f5a6-c7d8-4e9f-a1b2-c3d4e5f6a7b8",
+ "metadata_type": "LOGICAL_TABLE",
+ "principal_privileges": [
+ {
+ "principal_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "principal_name": "john_doe",
+ "principal_type": "USER",
+ "object_privileges": [
+ "SPOTTER_COACHING_PRIVILEGE"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
}
}
}
@@ -8734,6 +15231,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8744,6 +15253,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8754,6 +15275,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8764,6 +15297,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8843,6 +15388,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8853,6 +15410,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8863,6 +15432,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -8873,6 +15454,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -8972,6 +15565,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -8982,6 +15587,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -8992,6 +15609,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9002,6 +15631,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9038,6 +15679,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9048,6 +15701,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9058,6 +15723,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9068,6 +15745,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9104,6 +15793,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9114,6 +15815,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9124,6 +15837,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9134,6 +15859,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9170,6 +15907,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9180,6 +15929,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9190,6 +15951,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9200,6 +15973,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9236,6 +16021,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9246,6 +16043,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9256,6 +16065,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9266,6 +16087,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9302,6 +16135,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9312,6 +16157,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9322,6 +16179,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9332,6 +16201,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9368,6 +16249,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9378,6 +16271,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9388,6 +16293,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9398,6 +16315,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9434,6 +16363,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9444,6 +16385,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9454,6 +16407,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9464,6 +16429,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9506,6 +16483,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9516,6 +16505,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9526,6 +16527,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9536,6 +16549,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9598,6 +16623,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9608,6 +16645,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9618,6 +16667,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9628,6 +16689,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9651,6 +16724,19 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemOverrideInfo"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Returns system configuration override details",
+ "value": {
+ "config_override_info": {
+ "disable_cors": false,
+ "enableColumnLevelSecurity": true,
+ "maxRowsInExport": 100000,
+ "sessionTimeout": 86400
+ }
+ }
+ }
}
}
}
@@ -9661,6 +16747,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9671,6 +16769,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9681,6 +16791,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9691,6 +16813,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9764,6 +16898,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9774,6 +16920,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9784,6 +16942,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9794,6 +16964,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9901,6 +17083,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9911,6 +17105,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9921,6 +17127,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9931,6 +17149,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -9967,6 +17197,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -9977,6 +17219,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -9987,6 +17241,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -9997,6 +17263,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10030,6 +17308,46 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommunicationChannelValidateResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Webhook validation successful",
+ "value": {
+ "channel_type": "WEBHOOK",
+ "channel_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+ "channel_name": "My Liveboard Webhook",
+ "event_type": "LIVEBOARD_SCHEDULE",
+ "job_id": "job-abc123-def456",
+ "result_code": "SUCCESS",
+ "details": [
+ {
+ "validation_step": "HTTP_CONNECTION_CHECK",
+ "status": "SUCCESS",
+ "http_status": 200,
+ "error_message": null
+ }
+ ]
+ }
+ },
+ "example_2": {
+ "description": "Webhook validation failed",
+ "value": {
+ "channel_type": "WEBHOOK",
+ "channel_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ "channel_name": "Failed Webhook",
+ "event_type": "LIVEBOARD_SCHEDULE",
+ "job_id": "job-xyz789-uvw012",
+ "result_code": "FAILED",
+ "details": [
+ {
+ "validation_step": "HTTP_CONNECTION_CHECK",
+ "status": "FAILED",
+ "http_status": 404,
+ "error_message": "Connection refused: target URL unreachable"
+ }
+ ]
+ }
+ }
}
}
}
@@ -10040,6 +17358,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10050,6 +17380,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10060,6 +17402,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10070,6 +17424,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10106,6 +17472,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10116,6 +17494,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10126,6 +17516,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10136,6 +17538,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10172,6 +17586,7 @@
},
"examples": {
"example_1": {
+ "description": "Tag created successfully",
"value": {
"name": "test5",
"id": "6abf5aec-3485-4f83-b25f-8c55b92e2b20",
@@ -10197,6 +17612,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10207,6 +17634,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10217,6 +17656,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10227,6 +17678,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10263,6 +17726,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10273,6 +17748,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10283,6 +17770,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10293,6 +17792,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10373,6 +17884,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10383,6 +17906,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10393,6 +17928,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10403,6 +17950,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10439,6 +17998,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10449,6 +18020,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10459,6 +18042,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10469,6 +18064,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10515,6 +18122,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10525,6 +18144,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10535,6 +18166,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10545,6 +18188,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10578,6 +18233,22 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
+ },
+ "examples": {
+ "example_1": {
+ "description": "User activated successfully",
+ "value": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe",
+ "display_name": "John Doe",
+ "visibility": "SHARABLE",
+ "account_type": "LOCAL_USER",
+ "account_status": "ACTIVE",
+ "email": "john.doe@example.com",
+ "creation_time_in_millis": 1724277430000,
+ "modification_time_in_millis": 1724277430000
+ }
+ }
}
}
}
@@ -10588,6 +18259,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10598,6 +18281,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10608,6 +18303,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10618,6 +18325,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10654,6 +18373,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10664,6 +18395,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10674,6 +18417,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10684,6 +18439,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10717,6 +18484,24 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
+ },
+ "examples": {
+ "example_1": {
+ "description": "User created successfully",
+ "value": {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe",
+ "display_name": "John Doe",
+ "visibility": "SHARABLE",
+ "account_type": "LOCAL_USER",
+ "account_status": "ACTIVE",
+ "email": "john.doe@example.com",
+ "creation_time_in_millis": 1724277430000,
+ "modification_time_in_millis": 1724277430000,
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "complete_detail": true
+ }
+ }
}
}
}
@@ -10727,6 +18512,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10737,6 +18534,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10747,6 +18556,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10757,6 +18578,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10790,6 +18623,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseActivationURL"
+ },
+ "examples": {
+ "example_1": {
+ "description": "User deactivated and activation link returned",
+ "value": {
+ "activation_link": "https://your-thoughtspot-instance.thoughtspot.cloud/activate?token=abc123xyz"
+ }
+ }
}
}
}
@@ -10800,6 +18641,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10810,6 +18663,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10820,6 +18685,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10830,6 +18707,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10866,6 +18755,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10876,6 +18777,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10886,6 +18799,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10896,6 +18821,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10932,6 +18869,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -10942,6 +18891,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -10952,6 +18913,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -10962,6 +18935,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -10995,6 +18980,25 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportUsersResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Dry run result showing users that would be created/updated",
+ "value": {
+ "users_added": [
+ {
+ "id": "new-user-guid-1",
+ "name": "alice_wonder"
+ },
+ {
+ "id": "new-user-guid-2",
+ "name": "bob_builder"
+ }
+ ],
+ "users_deleted": [],
+ "users_updated": []
+ }
+ }
}
}
}
@@ -11005,6 +19009,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11015,6 +19031,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11025,6 +19053,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11035,6 +19075,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11071,6 +19123,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11081,6 +19145,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11091,6 +19167,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11101,6 +19189,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11137,6 +19237,43 @@
"items": {
"$ref": "#/components/schemas/User"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all active local users",
+ "value": [
+ {
+ "id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "name": "john_doe",
+ "display_name": "John Doe",
+ "visibility": "SHARABLE",
+ "account_type": "LOCAL_USER",
+ "account_status": "ACTIVE",
+ "email": "john.doe@example.com",
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1685441468684,
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "complete_detail": true,
+ "current_org": {
+ "id": 0,
+ "name": "Primary"
+ }
+ },
+ {
+ "id": "7f5e7f87-09a1-487c-a1da-c4bb35e45270",
+ "name": "jane_smith",
+ "display_name": "Jane Smith",
+ "visibility": "SHARABLE",
+ "account_type": "LOCAL_USER",
+ "account_status": "ACTIVE",
+ "email": "jane.smith@example.com",
+ "creation_time_in_millis": 1685441468684,
+ "modification_time_in_millis": 1685441468684,
+ "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a",
+ "complete_detail": true
+ }
+ ]
+ }
}
}
}
@@ -11147,6 +19284,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11157,6 +19306,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11167,6 +19328,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11177,6 +19350,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11223,6 +19408,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11233,6 +19430,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11243,6 +19452,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11253,6 +19474,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11286,6 +19519,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Variable"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Variable created successfully",
+ "value": {
+ "id": "var-a1b2c3d4-e5f6",
+ "name": "warehouse_config",
+ "variable_type": "CONNECTION_PROPERTY",
+ "sensitive": false,
+ "values": []
+ }
+ }
}
}
}
@@ -11296,6 +19541,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11306,6 +19563,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11316,6 +19585,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11326,6 +19607,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11363,6 +19656,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11373,6 +19678,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11383,6 +19700,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11393,6 +19722,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11429,6 +19770,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11439,6 +19792,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11449,6 +19814,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11459,6 +19836,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11505,6 +19894,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11515,6 +19916,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11525,6 +19938,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11535,6 +19960,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11571,6 +20008,33 @@
"items": {
"$ref": "#/components/schemas/Variable"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search all connection property variables",
+ "value": [
+ {
+ "id": "var-a1b2c3d4-e5f6",
+ "name": "warehouse_config",
+ "variable_type": "CONNECTION_PROPERTY",
+ "sensitive": false,
+ "values": [
+ {
+ "value": "COMPUTE_WH",
+ "org_identifier": "Primary",
+ "priority": 1
+ }
+ ]
+ },
+ {
+ "id": "var-b2c3d4e5-f6g7",
+ "name": "db_password",
+ "variable_type": "CONNECTION_PROPERTY",
+ "sensitive": true,
+ "values": []
+ }
+ ]
+ }
}
}
}
@@ -11581,6 +20045,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11591,6 +20067,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11601,6 +20089,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11611,6 +20111,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11657,6 +20169,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11667,6 +20191,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11677,6 +20213,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11687,6 +20235,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11724,6 +20284,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11734,6 +20306,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11744,6 +20328,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11754,6 +20350,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11787,6 +20395,32 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommitResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Objects committed to branch successfully",
+ "value": {
+ "committer": {
+ "email": "service@github.com",
+ "username": "ts-service-account"
+ },
+ "author": {
+ "email": "admin@example.com",
+ "username": "tsadmin"
+ },
+ "comment": "Add Q1 2024 sales dashboard",
+ "commit_time": "2024-08-21T12:30:00Z",
+ "commit_id": "a1b2c3d4e5f6789012345678901234567890abcd",
+ "branch": "main",
+ "committed_files": [
+ {
+ "file_name": "Liveboard/Sales_Dashboard.liveboard.tml",
+ "status_code": "OK",
+ "status_message": "File committed successfully"
+ }
+ ]
+ }
+ }
}
}
}
@@ -11797,6 +20431,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11807,6 +20453,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11817,6 +20475,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11827,6 +20497,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11860,6 +20542,26 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/RepoConfigObject"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Version control configuration created successfully",
+ "value": {
+ "repository_url": "https://github.com/mycompany/thoughtspot-content.git",
+ "username": "ts-service-account",
+ "commit_branch_name": "main",
+ "branches": [
+ "main",
+ "development"
+ ],
+ "enable_guid_mapping": true,
+ "configuration_branch_name": "ts_config_files",
+ "org": {
+ "id": 0,
+ "name": "Primary"
+ }
+ }
+ }
}
}
}
@@ -11870,6 +20572,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11880,6 +20594,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11890,6 +20616,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11900,6 +20638,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -11936,6 +20686,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -11946,6 +20708,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -11956,6 +20730,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -11966,6 +20752,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12002,6 +20800,20 @@
"items": {
"$ref": "#/components/schemas/DeployResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Commit deployed successfully",
+ "value": [
+ {
+ "file_name": "Liveboard/Sales_Dashboard.liveboard.tml",
+ "metadata_name": "Sales Dashboard",
+ "metadata_type": "LIVEBOARD",
+ "status_code": "OK",
+ "status_message": "Deployed successfully"
+ }
+ ]
+ }
}
}
}
@@ -12012,6 +20824,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12022,6 +20846,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12032,6 +20868,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12042,6 +20890,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12085,6 +20945,40 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevertResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Commit reverted successfully",
+ "value": {
+ "committer": {
+ "email": "service@github.com",
+ "username": "ts-service-account"
+ },
+ "author": {
+ "email": "admin@example.com",
+ "username": "tsadmin"
+ },
+ "comment": "Revert to commit abc123def456",
+ "commit_time": "2024-08-21T13:00:00Z",
+ "commit_id": "def456abc789012345678901234567890abcdef",
+ "branch": "main",
+ "committed_files": [
+ {
+ "file_name": "Liveboard/Sales_Dashboard.liveboard.tml",
+ "status_code": "OK"
+ }
+ ],
+ "reverted_metadata": [
+ {
+ "file_name": "Liveboard/Sales_Dashboard.liveboard.tml",
+ "metadata_name": "Sales Dashboard",
+ "metadata_type": "LIVEBOARD",
+ "status_code": "OK",
+ "status_message": "Successfully reverted"
+ }
+ ]
+ }
+ }
}
}
}
@@ -12095,6 +20989,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12105,6 +21011,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12115,6 +21033,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12125,6 +21055,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12161,6 +21103,41 @@
"items": {
"$ref": "#/components/schemas/CommitHistoryResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Commit history for a Liveboard",
+ "value": [
+ {
+ "committer": {
+ "email": "service@github.com",
+ "username": "ts-service-account"
+ },
+ "author": {
+ "email": "admin@example.com",
+ "username": "tsadmin"
+ },
+ "comment": "Add Q1 2024 sales dashboard",
+ "commit_time": "2024-08-21T12:30:00Z",
+ "commit_id": "a1b2c3d4e5f6789012345678901234567890abcd",
+ "branch": "main"
+ },
+ {
+ "committer": {
+ "email": "service@github.com",
+ "username": "ts-service-account"
+ },
+ "author": {
+ "email": "john.doe@example.com",
+ "username": "john_doe"
+ },
+ "comment": "Update visualization layout",
+ "commit_time": "2024-08-15T09:15:00Z",
+ "commit_id": "b2c3d4e5f678901234567890123456789012abcd",
+ "branch": "main"
+ }
+ ]
+ }
}
}
}
@@ -12171,6 +21148,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12181,6 +21170,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12191,6 +21192,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12201,6 +21214,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12237,6 +21262,29 @@
"items": {
"$ref": "#/components/schemas/RepoConfigObject"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Search version control configurations",
+ "value": [
+ {
+ "repository_url": "https://github.com/mycompany/thoughtspot-content.git",
+ "username": "ts-service-account",
+ "commit_branch_name": "main",
+ "branches": [
+ "main",
+ "development",
+ "staging"
+ ],
+ "enable_guid_mapping": true,
+ "configuration_branch_name": "ts_config_files",
+ "org": {
+ "id": 0,
+ "name": "Primary"
+ }
+ }
+ ]
+ }
}
}
}
@@ -12247,6 +21295,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12257,6 +21317,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12267,6 +21339,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12277,6 +21361,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12310,6 +21406,23 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/RepoConfigObject"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Version control configuration updated successfully",
+ "value": {
+ "repository_url": "https://github.com/mycompany/thoughtspot-content.git",
+ "username": "ts-service-account",
+ "commit_branch_name": "main",
+ "branches": [
+ "main",
+ "development",
+ "staging"
+ ],
+ "enable_guid_mapping": true,
+ "configuration_branch_name": "ts_config_files"
+ }
+ }
}
}
}
@@ -12320,6 +21433,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12330,6 +21455,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12340,6 +21477,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12350,6 +21499,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12386,6 +21547,27 @@
"items": {
"$ref": "#/components/schemas/DeployResponse"
}
+ },
+ "examples": {
+ "example_1": {
+ "description": "Merge validation result",
+ "value": [
+ {
+ "file_name": "Liveboard/Sales_Dashboard.liveboard.tml",
+ "metadata_name": "Sales Dashboard",
+ "metadata_type": "LIVEBOARD",
+ "status_code": "OK",
+ "status_message": "No conflicts found"
+ },
+ {
+ "file_name": "Answer/Revenue_Analysis.answer.tml",
+ "metadata_name": "Revenue Analysis",
+ "metadata_type": "ANSWER",
+ "status_code": "CONFLICT",
+ "status_message": "Merge conflict detected in visualization settings"
+ }
+ ]
+ }
}
}
}
@@ -12396,6 +21578,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12406,6 +21600,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12416,6 +21622,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12426,6 +21644,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12549,6 +21779,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12559,6 +21801,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12569,6 +21823,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12579,6 +21845,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12704,7 +21982,7 @@
{
"id": "a3f7c1e4-9b2d-4a6e-8f3c-1e5b7a9c4f2e",
"name": "Non-existent Webhook",
- "error_message": "Webhook not found or access denied"
+ "error": "Webhook not found or access denied"
}
]
}
@@ -12719,6 +21997,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12729,6 +22019,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12739,6 +22041,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12749,6 +22063,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12889,6 +22215,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12899,6 +22237,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12909,6 +22259,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12919,6 +22281,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -12965,6 +22339,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Operation failed due to an invalid input",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Invalid parameter value: one or more request parameters are missing or invalid."
+ }
+ }
+ }
+ }
}
}
}
@@ -12975,6 +22361,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Unauthorized access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "Access denied. Please authenticate using a valid token."
+ }
+ }
+ }
+ }
}
}
}
@@ -12985,6 +22383,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Forbidden access",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "You do not have permission to perform this operation."
+ }
+ }
+ }
+ }
}
}
}
@@ -12995,6 +22405,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
+ },
+ "examples": {
+ "example_1": {
+ "description": "Internal server error",
+ "value": {
+ "error": {
+ "message": {
+ "debug": "An unexpected error occurred. Please try again or contact support."
+ }
+ }
+ }
+ }
}
}
}
@@ -16764,39 +26186,6 @@
}
}
},
- "AgentInstructions": {
- "type": "object",
- "required": [
- "instructions"
- ],
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of the record.",
- "nullable": true
- },
- "instructions": {
- "type": "string",
- "description": "The admin instructions text for the agent."
- },
- "created_at": {
- "type": "string",
- "description": "ISO timestamp when the instructions were created.",
- "nullable": true
- },
- "updated_at": {
- "type": "string",
- "description": "ISO timestamp when the instructions were last updated.",
- "nullable": true
- },
- "last_updated_by": {
- "type": "string",
- "description": "User ID of the admin who last updated the instructions.",
- "nullable": true
- }
- },
- "description": "Admin instructions configured for the AI agent."
- },
"RiseGQLArgWrapper": {
"type": "object",
"required": [
@@ -22301,18 +31690,6 @@
"message"
]
},
- "SetAgentInstructionsRequest": {
- "type": "object",
- "properties": {
- "instructions": {
- "description": "The admin instructions text to set for the agent.",
- "type": "string"
- }
- },
- "required": [
- "instructions"
- ]
- },
"SetNLInstructionsRequest": {
"type": "object",
"properties": {
@@ -28968,4 +38345,4 @@
}
}
]
-}
\ No newline at end of file
+}