Get request template
GET
/v1/request-templates/{id}
const url = 'https://localhost:8080/v1/request-templates/example';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://localhost:8080/v1/request-templates/example \ --header 'Authorization: <Authorization>'Returns an available personal or configured request template in the active organization
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request template ID
Responses
Section titled “Responses”OK
Media typeapplication/json
object
data
object
business_justification
string
can_manage
boolean
created_at
string
datasource_names
Array<string>
description
string
id
string
name
string
parameters
Parameters are derived from [tag] placeholders in the scope’s raw
filters; the requester supplies them when creating a request.
Array<object>
object
name
string
type
string
uses
Array<object>
object
column
string
datasource
string
op
string
table
string
risk_level
string
scope
Array<object>
object
datasets
required
Array<object>
object
columns
required
Array<string>
filters
object
conditions
required
Array<object>
object
column
string
op
string
raw
string
value
logic
string
joins
Array<object>
object
on
string
source
object
kind
string
name
string
type
string
source
object
kind
string
name
string
datasource
required
string
virtual_table
object
name
string
sql
string
title
string
updated_at
string
validity_period
string
success
boolean
Example generated
{ "data": { "business_justification": "example", "can_manage": true, "created_at": "example", "datasource_names": [ "example" ], "description": "example", "id": "example", "name": "example", "parameters": [ { "name": "example", "type": "example", "uses": [ { "column": "example", "datasource": "example", "op": "example", "table": "example" } ] } ], "risk_level": "example", "scope": [ { "datasets": [ { "columns": [ "example" ], "filters": { "conditions": [ { "column": "example", "op": "example", "raw": "example", "value": "example" } ], "logic": "example" }, "joins": [ { "on": "example", "source": { "kind": "example", "name": "example" }, "type": "example" } ], "source": { "kind": "example", "name": "example" } } ], "datasource": "example", "virtual_table": { "name": "example", "sql": "example" } } ], "title": "example", "updated_at": "example", "validity_period": "example" }, "success": true}Unauthorized
Media typeapplication/json
object
error
string
message
string
success
boolean
Example
{ "error": "", "message": "Success", "success": true}Not Found
Media typeapplication/json
object
error
string
message
string
success
boolean
Example
{ "error": "", "message": "Success", "success": true}Internal Server Error
Media typeapplication/json
object
error
string
message
string
success
boolean
Example
{ "error": "", "message": "Success", "success": true}