{ "info": { "_postman_id": "7e5f5cbe-e133-4038-b7e3-de7f661eb7b1", "name": "ThoughtSpot Public REST 10.1.0.cl 26.4.0.cl API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:13:53.000Z", "updatedAt": "2026-07-28T03:13:53.000Z", "lastUpdatedBy": "35240", "uid": "35240-7e5f5cbe-e133-4038-b7e3-de7f661eb7b1" }, "item": [ { "name": "api", "item": [ { "name": "rest", "item": [ { "name": "2.0", "item": [ { "name": "collections", "item": [ { "name": "create", "item": [ { "name": "create Collection", "id": "a66dd40a-d31f-4c53-998a-1e5f9464fb24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"LIVEBOARD\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "create" ] }, "description": "\n Version: 26.4.0.cl or later\n\nCreates a new collection in ThoughtSpot.\n\nCollections allow you to organize and group related metadata objects such as Liveboards, Answers, worksheets, and other data objects. You can also create nested collections (sub-collections) to build a hierarchical structure.\n\n#### Supported operations\n\nThe API endpoint lets you perform the following operations:\n\n* Create a new collection\n* Add metadata objects (Liveboards, Answers, Logical Tables) to the collection\n* Create nested collections by adding sub-collections\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "95631240-b9e4-440a-80ad-f3f5b715d6e9", "name": "Collection created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"LIVEBOARD\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"obj_id\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"identifier\": \"\",\n \"name\": \"\"\n },\n {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"identifier\": \"\",\n \"name\": \"\"\n },\n {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"author_name\": \"\",\n \"author_id\": \"\",\n \"org\": {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-95631240-b9e4-440a-80ad-f3f5b715d6e9" }, { "id": "62a24206-d52a-4f3a-89dd-70c86b5a2698", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"LIVEBOARD\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "create" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-62a24206-d52a-4f3a-89dd-70c86b5a2698" }, { "id": "5c395c36-a6be-4502-81f2-09c48525c693", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"LIVEBOARD\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "create" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-5c395c36-a6be-4502-81f2-09c48525c693" }, { "id": "6c6e0536-8eb8-49ef-a92d-4579b9a01061", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"LIVEBOARD\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "create" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-6c6e0536-8eb8-49ef-a92d-4579b9a01061" }, { "id": "16f5af20-6a1a-49c5-a163-d244725d36b4", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"LIVEBOARD\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-16f5af20-6a1a-49c5-a163-d244725d36b4" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-a66dd40a-d31f-4c53-998a-1e5f9464fb24" } ], "id": "a6f48e4f-d7e6-45f3-845c-bde3ee0bdd8a", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-a6f48e4f-d7e6-45f3-845c-bde3ee0bdd8a" }, { "name": "delete", "item": [ { "name": "delete Collection", "id": "11db5114-7f5b-4dd3-b779-2a7496f30490", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] }, "description": "\n Version: 26.4.0.cl or later\n\nDeletes one or more collections from ThoughtSpot.\n\n#### Delete options\n\n* **delete_children**: When set to `true`, deletes the child objects (metadata items) within the collection that the user has access to. Objects that the user does not have permission to delete will be skipped.\n* **dry_run**: When set to `true`, performs a preview of the deletion operation without actually deleting anything. The response shows what would be deleted, allowing you to review before committing the deletion.\n\n#### Response\n\nThe response includes:\n* **metadata_deleted**: List of metadata objects that were successfully deleted\n* **metadata_skipped**: List of metadata objects that were skipped due to lack of permissions or other constraints\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "b7b63270-3b5b-4358-9ef5-d5c947349d56", "name": "Collections deleted successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metadata_deleted\": [\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"metadata_skipped\": [\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-b7b63270-3b5b-4358-9ef5-d5c947349d56" }, { "id": "0d358947-6e5b-4e88-a624-b788fc2dd7f1", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-0d358947-6e5b-4e88-a624-b788fc2dd7f1" }, { "id": "d808b14a-80d6-436b-81b1-df86eee5de8a", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-d808b14a-80d6-436b-81b1-df86eee5de8a" }, { "id": "c1e363b9-597a-46fc-822f-48e97e12239a", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-c1e363b9-597a-46fc-822f-48e97e12239a" }, { "id": "a8e29f94-26b2-4dd5-b077-092fdc873102", "name": "Resource not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-a8e29f94-26b2-4dd5-b077-092fdc873102" }, { "id": "78407d79-72b2-4075-93d4-54cd7b1266b1", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"delete_children\": false,\n \"dry_run\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "delete" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-78407d79-72b2-4075-93d4-54cd7b1266b1" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-11db5114-7f5b-4dd3-b779-2a7496f30490" } ], "id": "600f5fe1-9886-45fc-abb5-333ea89c650a", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-600f5fe1-9886-45fc-abb5-333ea89c650a" }, { "name": "search", "item": [ { "name": "search Collections", "id": "c3c5e7b8-ba2b-416c-af95-a647f48a326a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name_pattern\": \"\",\n \"record_offset\": 0,\n \"record_size\": 10,\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"created_by_user_identifiers\": [\n \"\",\n \"\"\n ],\n \"include_metadata\": false,\n \"sort_options\": {\n \"field_name\": \"MODIFIED\",\n \"order\": \"DESC\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "search" ] }, "description": "\n Version: 26.4.0.cl or later\n\nGets a list of collections available in ThoughtSpot.\n\nTo get details of a specific collection, specify the collection GUID or name. You can also filter the API response based on the collection name pattern, author, and other criteria.\n\n#### Search options\n\n* **name_pattern**: Use '%' as a wildcard character to match collection names\n* **collection_identifiers**: Search for specific collections by their GUIDs or names\n* **include_metadata**: When set to `true`, includes the metadata objects within each collection in the response\n\n**NOTE**: In addition to the GUID and name, `collection_identifiers` accepts a Custom object ID if one is configured for the collection. The response also includes the `obj_id` field for each collection that has one set.\n\n**NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available collections, set `record_size` to `-1`.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "cdd094eb-408f-4443-9f0b-de3e287fd5f4", "name": "Successfully retrieved list of collections", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name_pattern\": \"\",\n \"record_offset\": 0,\n \"record_size\": 10,\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"created_by_user_identifiers\": [\n \"\",\n \"\"\n ],\n \"include_metadata\": false,\n \"sort_options\": {\n \"field_name\": \"MODIFIED\",\n \"order\": \"DESC\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"collections\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"obj_id\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"identifier\": \"\",\n \"name\": \"\"\n },\n {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"identifier\": \"\",\n \"name\": \"\"\n },\n {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"author_name\": \"\",\n \"author_id\": \"\",\n \"org\": {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"obj_id\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"identifier\": \"\",\n \"name\": \"\"\n },\n {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"identifiers\": [\n {\n \"identifier\": \"\",\n \"name\": \"\"\n },\n {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"author_name\": \"\",\n \"author_id\": \"\",\n \"org\": {\n \"identifier\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"record_offset\": \"\",\n \"record_size\": \"\",\n \"is_last_batch\": \"\",\n \"count\": \"\"\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-cdd094eb-408f-4443-9f0b-de3e287fd5f4" }, { "id": "68b42d4d-6dc8-4462-9efb-5cb34643c1fb", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name_pattern\": \"\",\n \"record_offset\": 0,\n \"record_size\": 10,\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"created_by_user_identifiers\": [\n \"\",\n \"\"\n ],\n \"include_metadata\": false,\n \"sort_options\": {\n \"field_name\": \"MODIFIED\",\n \"order\": \"DESC\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-68b42d4d-6dc8-4462-9efb-5cb34643c1fb" }, { "id": "6ff7a7af-481e-4ff1-87a7-ad872cc2abba", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name_pattern\": \"\",\n \"record_offset\": 0,\n \"record_size\": 10,\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"created_by_user_identifiers\": [\n \"\",\n \"\"\n ],\n \"include_metadata\": false,\n \"sort_options\": {\n \"field_name\": \"MODIFIED\",\n \"order\": \"DESC\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-6ff7a7af-481e-4ff1-87a7-ad872cc2abba" }, { "id": "0a32d90e-94c1-4e75-837c-8aae65a9fe04", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name_pattern\": \"\",\n \"record_offset\": 0,\n \"record_size\": 10,\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"created_by_user_identifiers\": [\n \"\",\n \"\"\n ],\n \"include_metadata\": false,\n \"sort_options\": {\n \"field_name\": \"MODIFIED\",\n \"order\": \"DESC\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-0a32d90e-94c1-4e75-837c-8aae65a9fe04" }, { "id": "d6d1731f-77ae-4855-8ff0-759ea5d03fff", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name_pattern\": \"\",\n \"record_offset\": 0,\n \"record_size\": 10,\n \"collection_identifiers\": [\n \"\",\n \"\"\n ],\n \"created_by_user_identifiers\": [\n \"\",\n \"\"\n ],\n \"include_metadata\": false,\n \"sort_options\": {\n \"field_name\": \"MODIFIED\",\n \"order\": \"DESC\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-d6d1731f-77ae-4855-8ff0-759ea5d03fff" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-c3c5e7b8-ba2b-416c-af95-a647f48a326a" } ], "id": "841b7299-0bc3-4e91-96b3-1017e0e3832e", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-841b7299-0bc3-4e91-96b3-1017e0e3832e" }, { "name": "{collection_identifier}", "item": [ { "name": "update", "item": [ { "name": "update Collection", "id": "dfdd9761-f76d-41c2-b649-1e35a3175572", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "id": "7c0f2bcb-d33e-467e-8fa7-3800270c1038", "key": "collection_identifier", "value": "", "description": "(Required) Unique GUID of the collection. Note: Collection names cannot be used as\nidentifiers since duplicate names are allowed." } ] }, "description": "\n Version: 26.4.0.cl or later\n\nUpdates an existing collection in ThoughtSpot.\n\n#### Supported operations\n\nThis API endpoint lets you perform the following operations:\n\n* Update collection name and description\n* Change visibility settings\n* Add metadata objects to the collection (operation: ADD)\n* Remove metadata objects from the collection (operation: REMOVE)\n* Replace all metadata objects in the collection (operation: REPLACE)\n\n#### Operation types\n\n* **ADD**: Adds the specified metadata objects to the existing collection without removing current items\n* **REMOVE**: Removes only the specified metadata objects from the collection\n* **REPLACE**: Replaces all existing metadata objects with the specified items (default behavior)\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "49e12106-1345-4abe-a351-84fb3eb0dec9", "name": "Collection updated successfully. No content returned.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "key": "collection_identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-49e12106-1345-4abe-a351-84fb3eb0dec9" }, { "id": "d6cec3c8-3e5c-425b-9eea-6999add848bb", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "key": "collection_identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-d6cec3c8-3e5c-425b-9eea-6999add848bb" }, { "id": "766661a4-457b-4f6a-93a2-a13632832f1d", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "key": "collection_identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-766661a4-457b-4f6a-93a2-a13632832f1d" }, { "id": "00a5127f-af08-4794-a0c0-6aa78df51992", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "key": "collection_identifier" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-00a5127f-af08-4794-a0c0-6aa78df51992" }, { "id": "f315e208-5f6d-4114-9879-7e7679c531e0", "name": "Resource not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "key": "collection_identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-f315e208-5f6d-4114-9879-7e7679c531e0" }, { "id": "e9efa5be-1871-4ec9-9e1d-7c25c8d73cc4", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"LOGICAL_TABLE\",\n \"identifiers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/collections/:collection_identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "collections", ":collection_identifier", "update" ], "variable": [ { "key": "collection_identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-e9efa5be-1871-4ec9-9e1d-7c25c8d73cc4" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-dfdd9761-f76d-41c2-b649-1e35a3175572" } ], "id": "ace5de0e-81ff-4e4f-9543-99d6b09f9f24", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-ace5de0e-81ff-4e4f-9543-99d6b09f9f24" } ], "id": "f0bbe9b5-8f80-481d-a9e8-e03661e67a97", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-f0bbe9b5-8f80-481d-a9e8-e03661e67a97" } ], "id": "a36a517c-4c3f-4a35-a590-e5dc13e87ffc", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-a36a517c-4c3f-4a35-a590-e5dc13e87ffc" }, { "name": "jobs", "item": [ { "name": "history", "item": [ { "name": "communication-channels", "item": [ { "name": "search", "item": [ { "name": "search Channel History", "id": "9568885d-e40d-4532-b803-d0ee0ee80c4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"job_ids\": [\n \"\",\n \"\"\n ],\n \"channel_identifiers\": [\n \"\",\n \"\"\n ],\n \"channel_status\": \"RETRY\",\n \"events\": [\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n },\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n }\n ],\n \"start_epoch_time_in_millis\": \"\",\n \"end_epoch_time_in_millis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/jobs/history/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "jobs", "history", "communication-channels", "search" ] }, "description": "\n Version: 26.4.0.cl or later\n\nSearches delivery history for communication channels such as webhooks. Returns channel-level delivery status for each job execution record. Use this to monitor channel health and delivery success rates across events.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n**NOTE**: When `channel_type` is `WEBHOOK`, the following constraints apply:\n\n- `job_ids`, `channel_identifiers`, and `events` each accept at most one element.\n- When `job_ids` is provided, it is used as the sole lookup key and other filter fields are ignored.\n- When `job_ids` is not provided, `channel_identifiers` and `events` are both required, each containing exactly one element.\n- Records older than the configured retention period are not returned.\n- Use `start_epoch_time_in_millis` and/or `end_epoch_time_in_millis` to narrow results to a specific time window.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "e1aab23e-1b47-4110-a365-1b9763f74f44", "name": "Channel status logs retrieved successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"job_ids\": [\n \"\",\n \"\"\n ],\n \"channel_identifiers\": [\n \"\",\n \"\"\n ],\n \"channel_status\": \"RETRY\",\n \"events\": [\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n },\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n }\n ],\n \"start_epoch_time_in_millis\": \"\",\n \"end_epoch_time_in_millis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/jobs/history/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "jobs", "history", "communication-channels", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"jobs\": [\n {\n \"id\": \"\",\n \"status\": \"SUCCESS\",\n \"creation_time_in_millis\": \"\",\n \"event\": {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"run_id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"EXTERNAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"type\": \"USER\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"detail\": \"\",\n \"try_count\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"FAILED\",\n \"creation_time_in_millis\": \"\",\n \"event\": {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"id\": \"\",\n \"name\": \"\",\n \"run_id\": \"\"\n },\n \"recipients\": [\n {\n \"type\": \"EXTERNAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"type\": \"EXTERNAL\",\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"detail\": \"\",\n \"try_count\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-e1aab23e-1b47-4110-a365-1b9763f74f44" }, { "id": "4b9364bf-0431-4328-b245-70a5eddcfba4", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"job_ids\": [\n \"\",\n \"\"\n ],\n \"channel_identifiers\": [\n \"\",\n \"\"\n ],\n \"channel_status\": \"RETRY\",\n \"events\": [\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n },\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n }\n ],\n \"start_epoch_time_in_millis\": \"\",\n \"end_epoch_time_in_millis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/jobs/history/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "jobs", "history", "communication-channels", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-4b9364bf-0431-4328-b245-70a5eddcfba4" }, { "id": "4822f6f5-5a33-4a33-892f-68de1a6f9fe3", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"job_ids\": [\n \"\",\n \"\"\n ],\n \"channel_identifiers\": [\n \"\",\n \"\"\n ],\n \"channel_status\": \"RETRY\",\n \"events\": [\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n },\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n }\n ],\n \"start_epoch_time_in_millis\": \"\",\n \"end_epoch_time_in_millis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/jobs/history/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "jobs", "history", "communication-channels", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-4822f6f5-5a33-4a33-892f-68de1a6f9fe3" }, { "id": "3ff95cde-6bc0-4fe2-a219-3836ceddf2fb", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"job_ids\": [\n \"\",\n \"\"\n ],\n \"channel_identifiers\": [\n \"\",\n \"\"\n ],\n \"channel_status\": \"RETRY\",\n \"events\": [\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n },\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n }\n ],\n \"start_epoch_time_in_millis\": \"\",\n \"end_epoch_time_in_millis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/jobs/history/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "jobs", "history", "communication-channels", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-3ff95cde-6bc0-4fe2-a219-3836ceddf2fb" }, { "id": "a1a507a8-290c-4561-9b2e-5ddc741a1db7", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"job_ids\": [\n \"\",\n \"\"\n ],\n \"channel_identifiers\": [\n \"\",\n \"\"\n ],\n \"channel_status\": \"RETRY\",\n \"events\": [\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n },\n {\n \"type\": \"LIVEBOARD_SCHEDULE\",\n \"identifier\": \"\"\n }\n ],\n \"start_epoch_time_in_millis\": \"\",\n \"end_epoch_time_in_millis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/jobs/history/communication-channels/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "jobs", "history", "communication-channels", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-a1a507a8-290c-4561-9b2e-5ddc741a1db7" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-9568885d-e40d-4532-b803-d0ee0ee80c4c" } ], "id": "dc21209b-064c-4012-8c2a-6bfacce196d9", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-dc21209b-064c-4012-8c2a-6bfacce196d9" } ], "id": "ce4fa87e-a6d0-4343-be81-e59a212665aa", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-ce4fa87e-a6d0-4343-be81-e59a212665aa" } ], "id": "95538f1b-b25e-485d-b506-b05a9bf058ce", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-95538f1b-b25e-485d-b506-b05a9bf058ce" } ], "id": "17bd97f8-2a5d-4c6a-932f-7e75794e0cd9", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-17bd97f8-2a5d-4c6a-932f-7e75794e0cd9" }, { "name": "system", "item": [ { "name": "communication-channels", "item": [ { "name": "validate", "item": [ { "name": "validate Communication Channel", "id": "ec889f2a-1d88-4e8b-8911-47a2a16b6bf6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/communication-channels/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "communication-channels", "validate" ] }, "description": "\nBeta Version: 26.4.0.cl or later\n\nValidates a communication channel configuration to ensure it is properly set up and can receive events.\n- Use `channel_type` to specify the type of communication channel to validate (e.g., WEBHOOK).\n- Use `channel_identifier` to provide the unique identifier or name for the communication channel.\n- Use `event_type` to specify the event type to validate for this channel.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. For webhook channels, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "310b4dd1-0a2c-45db-acc4-baf71b247b90", "name": "communication channel configuration validated successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/communication-channels/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "communication-channels", "validate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_id\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\",\n \"job_id\": \"\",\n \"result_code\": \"FAILED\",\n \"channel_name\": \"\",\n \"details\": [\n {\n \"validation_step\": \"STORAGE_FILE_UPLOAD_CHECK\",\n \"status\": \"SUCCESS\",\n \"http_status\": \"\",\n \"error_message\": \"\",\n \"aws_s3_info\": {\n \"bucket_name\": \"\",\n \"file_name\": \"\",\n \"object_key\": \"\"\n },\n \"gcp_gcs_info\": {\n \"bucket_name\": \"\",\n \"file_name\": \"\",\n \"object_key\": \"\"\n }\n },\n {\n \"validation_step\": \"HTTP_CONNECTION_CHECK\",\n \"status\": \"FAILED\",\n \"http_status\": \"\",\n \"error_message\": \"\",\n \"aws_s3_info\": {\n \"bucket_name\": \"\",\n \"file_name\": \"\",\n \"object_key\": \"\"\n },\n \"gcp_gcs_info\": {\n \"bucket_name\": \"\",\n \"file_name\": \"\",\n \"object_key\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-310b4dd1-0a2c-45db-acc4-baf71b247b90" }, { "id": "237d312c-4602-4a84-ac82-28fa6c3c4b97", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/communication-channels/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "communication-channels", "validate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-237d312c-4602-4a84-ac82-28fa6c3c4b97" }, { "id": "fa9aad13-ba56-49a1-a7af-b96da84af898", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/communication-channels/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "communication-channels", "validate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-fa9aad13-ba56-49a1-a7af-b96da84af898" }, { "id": "f0bec024-25af-40f6-a120-c8ed3a05ad6c", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/communication-channels/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "communication-channels", "validate" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-f0bec024-25af-40f6-a120-c8ed3a05ad6c" }, { "id": "0e8ac971-7b27-464d-8c55-2f7a13660b1f", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_type\": \"WEBHOOK\",\n \"channel_identifier\": \"\",\n \"event_type\": \"LIVEBOARD_SCHEDULE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/system/communication-channels/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "system", "communication-channels", "validate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-0e8ac971-7b27-464d-8c55-2f7a13660b1f" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-ec889f2a-1d88-4e8b-8911-47a2a16b6bf6" } ], "id": "3382d600-61e4-411a-9a24-19785cc56138", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-3382d600-61e4-411a-9a24-19785cc56138" } ], "id": "6166ca71-4ad1-4b24-a4c0-edc4afebd43a", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-6166ca71-4ad1-4b24-a4c0-edc4afebd43a" } ], "id": "e7fa1cc2-c476-4ac1-b8d5-c1c2aa1fccfc", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-e7fa1cc2-c476-4ac1-b8d5-c1c2aa1fccfc" }, { "name": "template", "item": [ { "name": "variables", "item": [ { "name": "create", "item": [ { "name": "create Variable", "id": "56e507d1-9d27-49e0-8b38-ad1cc0cf42bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"CONNECTION_PROPERTY\",\n \"name\": \"\",\n \"is_sensitive\": false,\n \"data_type\": \"VARCHAR\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "create" ] }, "description": "\nCreate a variable which can be used for parameterizing metadata objects
Version: 26.4.0.cl or later\n\nAllows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports the following types of variables:\n* CONNECTION_PROPERTY - For connection properties\n* TABLE_MAPPING - For table mappings\n* CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this.\n* FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl\n\nWhen creating a variable, you need to specify:\n* The variable type\n* A unique name for the variable\n* Whether the variable contains sensitive values (defaults to false)\n* The data type of the variable, only specify for formula variables (defaults to null)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable name already exists\n* The variable type is invalid\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "e98513ce-2492-49e8-acaa-dd20de9b08bd", "name": "Create variable is successful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"CONNECTION_PROPERTY\",\n \"name\": \"\",\n \"is_sensitive\": false,\n \"data_type\": \"VARCHAR\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"variable_type\": \"FORMULA_VARIABLE\",\n \"sensitive\": \"\",\n \"values\": [\n {\n \"org_identifier\": \"\",\n \"value\": \"\",\n \"value_list\": [\n \"\",\n \"\"\n ],\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"value\": \"\",\n \"value_list\": [\n \"\",\n \"\"\n ],\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-e98513ce-2492-49e8-acaa-dd20de9b08bd" }, { "id": "12b6761d-24c0-47f0-ad3f-3ebce24a7468", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"CONNECTION_PROPERTY\",\n \"name\": \"\",\n \"is_sensitive\": false,\n \"data_type\": \"VARCHAR\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "create" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-12b6761d-24c0-47f0-ad3f-3ebce24a7468" }, { "id": "afafedae-c6cb-49f6-9633-590523c82a6c", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"CONNECTION_PROPERTY\",\n \"name\": \"\",\n \"is_sensitive\": false,\n \"data_type\": \"VARCHAR\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "create" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-afafedae-c6cb-49f6-9633-590523c82a6c" }, { "id": "0f5d37a3-cb90-4afa-a6f8-3551147fa1b0", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"CONNECTION_PROPERTY\",\n \"name\": \"\",\n \"is_sensitive\": false,\n \"data_type\": \"VARCHAR\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "create" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-0f5d37a3-cb90-4afa-a6f8-3551147fa1b0" }, { "id": "9fd9d792-5c59-4f05-b484-8a11e7550a74", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"CONNECTION_PROPERTY\",\n \"name\": \"\",\n \"is_sensitive\": false,\n \"data_type\": \"VARCHAR\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-9fd9d792-5c59-4f05-b484-8a11e7550a74" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-56e507d1-9d27-49e0-8b38-ad1cc0cf42bc" } ], "id": "6478bebd-e302-49a4-9c63-d6aebebf49b9", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-6478bebd-e302-49a4-9c63-d6aebebf49b9" }, { "name": "delete", "item": [ { "name": "delete Variables", "id": "12a59cb4-abc5-4166-9fa1-e2a299459a9e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "delete" ] }, "description": "\nDelete variable(s)
Version: 26.4.0.cl or later\n\nAllows deleting multiple variables from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifiers (IDs or names)\n\nThe operation will fail if:\n* The user lacks required permissions\n* Any of the variables don't exist\n* Any of the variables are being used by other objects\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "ce1d14c4-28b1-45b2-9f27-f208b640baa5", "name": "Deletion of variable(s) is successful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "delete" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-ce1d14c4-28b1-45b2-9f27-f208b640baa5" }, { "id": "646d8975-23fd-402e-9de7-c8a8b5048e1f", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "delete" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-646d8975-23fd-402e-9de7-c8a8b5048e1f" }, { "id": "906d6c72-d3b4-48b6-bcc7-956cca29fd75", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "delete" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-906d6c72-d3b4-48b6-bcc7-956cca29fd75" }, { "id": "8d0e4f3b-a2b1-418c-9af6-4ae0e4566800", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "delete" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-8d0e4f3b-a2b1-418c-9af6-4ae0e4566800" }, { "id": "43bd154c-b446-463e-9a1a-bc8dc203f9d5", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "delete" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-43bd154c-b446-463e-9a1a-bc8dc203f9d5" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-12a59cb4-abc5-4166-9fa1-e2a299459a9e" } ], "id": "cf4f4e35-4e9b-4509-a7bc-6512d6f5f1e3", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-cf4f4e35-4e9b-4509-a7bc-6512d6f5f1e3" }, { "name": "{identifier}", "item": [ { "name": "update-values", "item": [ { "name": "put Variable Values", "id": "b12b3864-6b30-4304-a2ea-fb780f1b45a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update-values" ], "variable": [ { "id": "915cc264-3962-4d78-9354-c969d852c5d4", "key": "identifier", "value": "", "description": "(Required) Unique ID or name of the variable" } ] }, "description": "\nUpdate values for a variable
Version: 26.4.0.cl or later\n\nAllows updating values for a specific variable in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to the variable\n* Replacing existing values\n* Deleting values from the variable\n* Resetting all values\n\nWhen updating variable values, you need to specify:\n* The variable identifier (ID or name)\n* The values to add/replace/remove\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constraints for the given variable, scope is ignored\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "1552a3a2-3ab7-4987-8e09-b18345117ea8", "name": "Variable values updated successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update-values" ], "variable": [ { "key": "identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-1552a3a2-3ab7-4987-8e09-b18345117ea8" }, { "id": "dcb8aee2-da33-4dca-a535-2724a6158c22", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update-values" ], "variable": [ { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-dcb8aee2-da33-4dca-a535-2724a6158c22" }, { "id": "594d25a9-d696-4187-8308-8eb50416e202", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update-values" ], "variable": [ { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-594d25a9-d696-4187-8308-8eb50416e202" }, { "id": "f4a17277-c6e0-4eda-80a7-d6afd451a7a9", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update-values" ], "variable": [ { "key": "identifier" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-f4a17277-c6e0-4eda-80a7-d6afd451a7a9" }, { "id": "59a20855-3d74-4909-84bf-98b146cdd295", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_assignment\": [\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"assigned_values\": [\n \"\",\n \"\"\n ],\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"operation\": \"REPLACE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update-values" ], "variable": [ { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-59a20855-3d74-4909-84bf-98b146cdd295" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-b12b3864-6b30-4304-a2ea-fb780f1b45a0" } ], "id": "b4dfa413-5999-4102-a040-acd786ea0579", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-b4dfa413-5999-4102-a040-acd786ea0579" }, { "name": "update", "item": [ { "name": "update Variable", "id": "fa88a2bf-b493-4cb5-8262-113ae18f9a69", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update" ], "variable": [ { "id": "f100300f-7fff-4f89-a200-17cda871c96a", "key": "identifier", "value": "", "description": "(Required) Unique id or name of the variable to update." } ] }, "description": "\nUpdate a variable's name
Version: 26.4.0.cl or later\n\nAllows updating a variable's name in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows updating:\n* The variable name\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "7a94653f-a112-48a1-ab33-e090eb32e023", "name": "Variable name updated successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update" ], "variable": [ { "key": "identifier" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-7a94653f-a112-48a1-ab33-e090eb32e023" }, { "id": "da12c320-1b1a-4eb9-b3d3-9b16273de7fe", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update" ], "variable": [ { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-da12c320-1b1a-4eb9-b3d3-9b16273de7fe" }, { "id": "d22b9242-72a8-40f0-8484-c2f595531fb4", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update" ], "variable": [ { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-d22b9242-72a8-40f0-8484-c2f595531fb4" }, { "id": "1055df5b-548d-4674-a822-aea85a0d7654", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update" ], "variable": [ { "key": "identifier" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-1055df5b-548d-4674-a822-aea85a0d7654" }, { "id": "919c140f-9e86-4f29-966b-08fe7870a034", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/:identifier/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", ":identifier", "update" ], "variable": [ { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-919c140f-9e86-4f29-966b-08fe7870a034" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-fa88a2bf-b493-4cb5-8262-113ae18f9a69" } ], "id": "b89fea4b-9dff-40e1-959d-f58794582b8b", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-b89fea4b-9dff-40e1-959d-f58794582b8b" } ], "id": "24562092-a9c9-4e0c-b125-f76e281d1fde", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-24562092-a9c9-4e0c-b125-f76e281d1fde" }, { "name": "search", "item": [ { "name": "search Variables", "id": "6f3d0708-6b58-4452-af5a-92e24942308f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"variable_details\": [\n {\n \"identifier\": \"\",\n \"type\": \"CONNECTION_PROPERTY_PER_PRINCIPAL\",\n \"name_pattern\": \"\"\n },\n {\n \"identifier\": \"\",\n \"type\": \"USER_PROPERTY\",\n \"name_pattern\": \"\"\n }\n ],\n \"value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 10,\n \"response_content\": \"METADATA\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "search" ] }, "description": "\nSearch variables
Version: 26.4.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports searching variables by:\n* Variable identifier (ID or name)\n* Variable type\n* Name pattern (case-insensitive, supports % for wildcard)\n\nThe search results can be formatted in three ways:\n* METADATA - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n\nThe values can be filtered by scope:\n* org_identifier\n* principal_identifier\n* model_identifier\n\n\n\n\n#### Endpoint URL\n" }, "response": [ { "id": "7f15a864-87d6-4ed7-aea0-017ebe329051", "name": "List of variables is successful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_details\": [\n {\n \"identifier\": \"\",\n \"type\": \"CONNECTION_PROPERTY_PER_PRINCIPAL\",\n \"name_pattern\": \"\"\n },\n {\n \"identifier\": \"\",\n \"type\": \"USER_PROPERTY\",\n \"name_pattern\": \"\"\n }\n ],\n \"value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 10,\n \"response_content\": \"METADATA\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"variable_type\": \"FORMULA_VARIABLE\",\n \"sensitive\": \"\",\n \"values\": [\n {\n \"org_identifier\": \"\",\n \"value\": \"\",\n \"value_list\": [\n \"\",\n \"\"\n ],\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"value\": \"\",\n \"value_list\": [\n \"\",\n \"\"\n ],\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"variable_type\": \"CONNECTION_PROPERTY\",\n \"sensitive\": \"\",\n \"values\": [\n {\n \"org_identifier\": \"\",\n \"value\": \"\",\n \"value_list\": [\n \"\",\n \"\"\n ],\n \"principal_type\": \"USER_GROUP\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"value\": \"\",\n \"value_list\": [\n \"\",\n \"\"\n ],\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\",\n \"priority\": \"\"\n }\n ],\n \"org\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-7f15a864-87d6-4ed7-aea0-017ebe329051" }, { "id": "bda4e1a1-fc70-4dc3-81b1-847ce93e0d96", "name": "Invalid request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_details\": [\n {\n \"identifier\": \"\",\n \"type\": \"CONNECTION_PROPERTY_PER_PRINCIPAL\",\n \"name_pattern\": \"\"\n },\n {\n \"identifier\": \"\",\n \"type\": \"USER_PROPERTY\",\n \"name_pattern\": \"\"\n }\n ],\n \"value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 10,\n \"response_content\": \"METADATA\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-bda4e1a1-fc70-4dc3-81b1-847ce93e0d96" }, { "id": "abce6977-60c9-4cba-84ae-b28a5e561b58", "name": "Unauthorized access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_details\": [\n {\n \"identifier\": \"\",\n \"type\": \"CONNECTION_PROPERTY_PER_PRINCIPAL\",\n \"name_pattern\": \"\"\n },\n {\n \"identifier\": \"\",\n \"type\": \"USER_PROPERTY\",\n \"name_pattern\": \"\"\n }\n ],\n \"value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 10,\n \"response_content\": \"METADATA\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-abce6977-60c9-4cba-84ae-b28a5e561b58" }, { "id": "33b370fd-db43-4ee3-9774-d545fda73c8e", "name": "Forbidden access.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_details\": [\n {\n \"identifier\": \"\",\n \"type\": \"CONNECTION_PROPERTY_PER_PRINCIPAL\",\n \"name_pattern\": \"\"\n },\n {\n \"identifier\": \"\",\n \"type\": \"USER_PROPERTY\",\n \"name_pattern\": \"\"\n }\n ],\n \"value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 10,\n \"response_content\": \"METADATA\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-33b370fd-db43-4ee3-9774-d545fda73c8e" }, { "id": "35b085dc-424c-4bda-95b8-5bdf7a107276", "name": "Unexpected error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"variable_details\": [\n {\n \"identifier\": \"\",\n \"type\": \"CONNECTION_PROPERTY_PER_PRINCIPAL\",\n \"name_pattern\": \"\"\n },\n {\n \"identifier\": \"\",\n \"type\": \"USER_PROPERTY\",\n \"name_pattern\": \"\"\n }\n ],\n \"value_scope\": [\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n },\n {\n \"org_identifier\": \"\",\n \"principal_type\": \"USER\",\n \"principal_identifier\": \"\",\n \"model_identifier\": \"\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 10,\n \"response_content\": \"METADATA\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/rest/2.0/template/variables/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "rest", "2.0", "template", "variables", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {}\n}", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-35b085dc-424c-4bda-95b8-5bdf7a107276" } ], "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-6f3d0708-6b58-4452-af5a-92e24942308f" } ], "id": "822f2ead-16be-46a4-bfd8-91d0dd77355a", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-822f2ead-16be-46a4-bfd8-91d0dd77355a" } ], "id": "d7e858ad-efc3-4371-b974-c23b7864a3b0", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-d7e858ad-efc3-4371-b974-c23b7864a3b0" } ], "id": "4fb1b9c0-9284-48a5-a91e-638dcdc790de", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-4fb1b9c0-9284-48a5-a91e-638dcdc790de" } ], "id": "857f19ad-f06d-4bc9-86be-b2a10e8383ad", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-857f19ad-f06d-4bc9-86be-b2a10e8383ad" } ], "id": "26d2fb7f-a40a-4288-b235-5080ce79bb58", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-26d2fb7f-a40a-4288-b235-5080ce79bb58" } ], "id": "813fdc02-9052-4985-bf3a-5b657d819ff6", "createdAt": "2026-07-28T03:13:54.000Z", "updatedAt": "2026-07-28T03:13:54.000Z", "uid": "35240-813fdc02-9052-4985-bf3a-5b657d819ff6" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "base-url", "value": "https://localhost:443" }, { "key": "baseUrl", "value": "{{base-url}}" } ] }