Resources

A resource is a component of the API that you can get and manage through API requests. A request is a message to a server describing the action you want to take relating to a resource. Resources are represented by nouns in the API requests and the request methods – by verbs (GET, POST, PUT, and DELETE).

For example, in the following request, the resource is datasources. The URI contains the location of the server and the exact resource ID that you want to request (in this example, GET).

curl -X GET "https://server/dp/api/v1/datasources/16442445976181878"

DataClarity resources

DataClarity‘s APIs let you operate on the following core resources:

aiconnections

A connection to Microsoft R, R, or Python server where the corresponding script language is available. The AI connection is used to run script and scalar calculations.

datasources

A database or other place where data is stored, such as Microsoft SQL Server,  Oracle, or PostgreSQL. Use the datasources resource to create datasets.

datasets

An organized collection of data that relates to specific topic and is collected for a particular purpose. In DataClarity, it is a set of data in a tabular form. A dataset can use a live connection or can be based on an extract.

extract

A dataset that is based on the snapshots of data that are loaded into the Data Engine server memory as highly optimized and compressed files. When you use extracts, you remove live connections to the databases and reduce the load on them.

storyboards

A collection of various widgets, such as visualizations, pictograms, and text. Visualizations’ data comes from datasets.

objects

One of the following: aiconnections, datasets, datasources, or storyboards. The resource is used in tags and certifications.

visualizations

A custom-built chart, filter, or tabular data view that is based on a user-defined dataset.

widget

A widget to connect to a Tableau view and TM1 Cube View from a storyboard.

You may also interact with additional resources such as:

access

A UUID (universally unique identifier) generated for a specified storyboard ID. The UUID is generated for each storyboard URL published to the web (make accessible over the internet).

jobs

A scheduler job for storyboard subscription.

palettes

One or more colors in a certain order that are applied to a visualization. Color palettes are categorized as diverging, qualitative, and sequential.

tags

A keyword that you can add to any object to help categorize and find the object. When searching for objects, you can use tags as search criteria.