Custom API Action

Make an authenticated request to the Tableau Cloud API.

Options

Field Definition Type Required

Request Type

These are the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).

  • GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content.

  • POST: Sends data to a web server based on parameters, for example, uploading a file. Multiple POST requests may result in a different outcome than a single POST. Exercise caution to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.

  • PUT: Sends data to be stored at a specific location on a web server based on parameters, such as uploading a file. Unlike POST requests, PUT requests are idempotent. For successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, a 200 (OK), 201 (Created), or 204 (No Content) response message is returned.

  • DELETE: Deletes the specified resource if it exists from the web server based on parameters. If a DELETE is successful, a 200 (OK) response message is returned.

Dropdown TRUE

Input

Field Definition Type Required

Request

Relative URL

The URL address of the web server that you're attempting to call. Specify the relative URL as /{insert_remaining_URL}.

You can specify query parameters in the relative URL using ?, or specify the query parameters as a key and value pair in the Query input.

For example, if the request URL is https://10ax.online.tableau.com/api/api-version/sites/site-id/groups, then the Relative URL is /groups. The site-id is not required as it's associated to the authorized connection.

See Tableau API Reference.

 Text TRUE

API Version

If this field isn't specified, the query uses 3.22 as the default API version.

See REST API and Resource Versions.

 Text FALSE

Scopes

Any required scopes needed for the JWT authorization of the Tableau API.

This JWT authorization must be configured with the scopes of the REST API methods available to the connected app.

See Access Scopes.

 List of Text TRUE

Query

Specify any additional query parameters that should be included as key and value pairs.

For example, {"name":"something-urgent"}.

 Object FALSE

Headers

Specify any headers required in addition to authorization or content-type, as the connector already handles those headers.

 Object FALSE

Body

Specify a request body in JSON format.

This input is only available for POST, PUT, and PATCH requests.

 Object FALSE

Output

Field Definition Type

Response

Status Code

(Undefined variable: workflows_fields.output-status-code)

Number

Headers

Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. This is similar to {"Content-type":"application/json"}.

 Object

Body

Data returned from your selected HTTP request.

For example, the data from a GET request.

 Object