This API returns a list of Datastores and their corresponding attributes. You can also get information on a specific Datastore and its attributes by specifying the Datastore ID in the API request.
What is DataStore Metadata?
The data store metadata consists of data store id, datastore name, and the column attributes such as column name, column id, and the data type.
When should I fetch datastore metadata? And what should I do after fetching it?
You can fetch the datastore metadata to know the datastore definition without logging into Webex Campaign. The fetched metadata is then used to analyze the datastore and take appropriate action to integrate with a 3rd party system.
Know your endpoint
Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.
Go to the Postman Collection section to learn how to import a Postman collection. Click the below button, If you already know how to import a postman collection.
Request Headers
The following table describes the request headers:
| Request Header | Description |
|---|---|
| content-Type | application/json |
| authorization | Access token or API Secret Key in Bearer format Example: Bearer $(key) |
Request Example
https://<domain>/campaignapi/metadata/v3/datastore/
https://<domain>/campaignapi/resources/metadata/v3/datastore/88
Response Parameters
This API will return the following response parameters:
| Parameter | Description |
|---|---|
| datastore-id | Returns the datastore id. |
| datastore-name | Returns the datastore name. |
| columns | Returns the columns. datatype: Returns the data type of the column. id: Returns the id of the column. name: Returns the name of the column. max-length: Returns the maximum length of the column. |
Failure Response Codes
The API will return code within the response as per the following table in case of failure scenarios.
| HTTP Status Code | Code within API Response | Description |
|---|---|---|
| 200 | 1010 | The request was not processed. |
| 1022 | Datastore Id does not exist | |
| 401 | 430 | Authorization failed. This resource is not allowed to access using this TOKEN or KEY |
| 498 | Invalid token or Access token expired | |
| 405 | 405 | Method not supported |
| 429 | 429 | Too many requests. Throttle limit reached for the time window. |
| 499 | 499 | Request failed. Check the exact reason of failure in application code and description of error stream. |
| 500 | 500 | Internal server error |