{
"opencollection": "1.0.0",
"info": {
"name": "ThoughtSpot Public REST 10.1.0.cl Metadata API",
"version": "2.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Metadata",
"type": "folder"
},
"items": [
{
"info": {
"name": "convertWorksheetToModel",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/worksheets/convert",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nConvert worksheets to models
Version: 10.6.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **worksheet_ids** \n - **Description:** A comma-separated list of GUIDs (Globally Unique Identifiers)"
},
{
"info": {
"name": "copyObject",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/copyobject",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nMakes a copy of an Answer or Liveboard
Version: 10.3.0.cl or later\n\nCreates a copy of a metadata object.\n\nRequires at least view access to the metadata object being copied.\n\nUpon successful execution, the API creates a copy of the metadata object specified in the API request and returns the ID of the new object.\n\n\n\n\n#### Endpoint URL\n"
},
{
"info": {
"name": "deleteMetadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/delete",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nRemoves the specified metadata object from the ThoughtSpot system.\n\nRequires edit access to the metadata object. \n\n\n\n\n#### Endpoint URL\n"
},
{
"info": {
"name": "exportMetadataTML",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/tml/export",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\nRequires `DATADOWNLOADING` (**Can download Data**) and at least view access to the metadata object.\n\n#### Usage guidelines\n\n* You can export one or several objects by passing metadata object GUIDs in the `metadata` array.\n* When exporting TML content for a Liveboard or Answer object, you can set `export_asso"
},
{
"info": {
"name": "exportMetadataTMLBatched",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/tml/export/batch",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.1.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\n### **Permissions Required**\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and `USERMANAGEMENT` (**Can manage users**) privileges.\n\n#### **Usage Guidelines**\n\nThis API is only applicable for `USER`, `GROUP`, and `ROLES` metadata types.\n\n- `batch_offset` Indicates the starting position within the complete"
},
{
"info": {
"name": "fetchAnswerSqlQuery",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/answer/sql",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nFetches the underlying SQL query data for an Answer object.\n\nRequires at least view access to the Answer object.\n\nUpon successful execution, the API returns the SQL queries for the specified object as shown in this example:\n```\n{\n \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\",\n \"metadata_name\":\"Total sales\",\n \"metadata_type\":\"ANSWER\",\n \"sql_queries\":[\n {\n \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada"
},
{
"info": {
"name": "fetchAsyncImportTaskStatus",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/tml/async/status",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.4.0.cl or later\n\nGets information about the status of the TML async import task scheduled using the `/api/rest/2.0/metadata/tml/async/import` API call.\n\nTo fetch the task details, specify the ID of the TML async import task. \n\nRequires access to the task ID. The API allows users who initiated the asynchronous TML import via `/api/rest/2.0/metadata/tml/async/import` to view the status of their tasks. Users with administration privilege can view "
},
{
"info": {
"name": "fetchLiveboardSqlQuery",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/liveboard/sql",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nFetches the underlying SQL query data for a Liveboard object and its visualizations.\n\nRequires at least view access to the Liveboard object.\n\nTo get SQL query data for a Liveboard, specify the GUID of the Liveboard. Optionally, you can add an array of visualization GUIDs to retrieve the SQL query data for visualizations in the Liveboard.\n\nUpon successful execution, the API returns the SQL queries for the specified object as shown "
},
{
"info": {
"name": "importMetadataTML",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/tml/import",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nImports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections*"
},
{
"info": {
"name": "importMetadataTMLAsync",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/tml/async/import",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.4.0.cl or later\n\nSchedules a task to import [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. You can use this API endpoint to process TML objects asynchronously when importing TMLs of large and complex metadata objects into ThoughtSpot. Unlike the synchronous import TML operation, the API processes TML data in the background and returns a task ID, which can be used to check the status of the import task via `/api/rest/"
},
{
"info": {
"name": "parameterizeMetadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/parameterize",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nParameterize fields in metadata objects.
Beta Version: 10.9.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/metadata/parameterize-fields](/api/rest/2.0/metadata/parameterize-fields) instead.\n\nAllows parameterizing fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API"
},
{
"info": {
"name": "parameterizeMetadataFields",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/parameterize-fields",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nParameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE.
Version: 26.5.0.cl or later\n\nAllows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* "
},
{
"info": {
"name": "searchMetadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 9.0.0.cl or later\n\nGets a list of metadata objects available on the ThoughtSpot system.\n\nThis API endpoint is available to all users who have view access to the object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view data for all metadata objects, including users and groups.\n\n#### Usage guidelines\n\n- To get all metadata objects, send the API request without any attributes.\n- To get metadata objects of a specific type"
},
{
"info": {
"name": "unparameterizeMetadata",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/unparameterize",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nRemove parameterization from fields in metadata objects.
Version: 26.5.0.cl or later\n\nAllows removing parameterization from fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows unparameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* d"
},
{
"info": {
"name": "updateMetadataHeader",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/headers/update",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nUpdate header attributes for a given list of header objects.
Beta Version: 10.6.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `ORG_ADMINISTRATION` (Can manage orgs).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **headers_update** \n - **Description:** List of he"
},
{
"info": {
"name": "updateMetadataObjId",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/metadata/update-obj-id",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nUpdate object IDs for given metadata objects.
Beta Version: 10.8.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `ORG_ADMINISTRATION` (Can manage orgs).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **metadata** \n - **Description:** List of metadata objects to upd"
}
]
}
],
"bundled": true
}