Skip to content

Latest commit

 

History

History
350 lines (256 loc) · 15.5 KB

RenderTaskApi.md

File metadata and controls

350 lines (256 loc) · 15.5 KB
Raw

Swagger\Client\RenderTaskApi

All URIs are relative to https://localhost:20000/api/3.1

Method HTTP request Description
createDashboardElementRenderTask POST /render_tasks/dashboard_elements/{dashboard_element_id}/{result_format} Create Dashboard Element Render Task
createDashboardRenderTask POST /render_tasks/dashboards/{dashboard_id}/{result_format} Create Dashboard Render Task
createLookRenderTask POST /render_tasks/looks/{look_id}/{result_format} Create Look Render Task
createQueryRenderTask POST /render_tasks/queries/{query_id}/{result_format} Create Query Render Task
renderTask GET /render_tasks/{render_task_id} Get Render Task
renderTaskResults GET /render_tasks/{render_task_id}/results Render Task Results

createDashboardElementRenderTask

\Swagger\Client\Model\RenderTask createDashboardElementRenderTask($dashboard_element_id, $result_format, $width, $height, $fields)

Create Dashboard Element Render Task

Create a new task to render a dashboard element to an image. Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\RenderTaskApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$dashboard_element_id = "dashboard_element_id_example"; // string | Id of dashboard element to render: UDD dashboard element would be numeric and LookML dashboard element would be model_name::dashboard_title::lookml_link_id
$result_format = "result_format_example"; // string | Output type: png or jpg
$width = 789; // int | Output width in pixels
$height = 789; // int | Output height in pixels
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createDashboardElementRenderTask($dashboard_element_id, $result_format, $width, $height, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderTaskApi->createDashboardElementRenderTask: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
dashboard_element_id string Id of dashboard element to render: UDD dashboard element would be numeric and LookML dashboard element would be model_name::dashboard_title::lookml_link_id
result_format string Output type: png or jpg
width int Output width in pixels
height int Output height in pixels
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\RenderTask

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createDashboardRenderTask

\Swagger\Client\Model\RenderTask createDashboardRenderTask($dashboard_id, $result_format, $body, $width, $height, $fields, $pdf_paper_size, $pdf_landscape, $long_tables)

Create Dashboard Render Task

Create a new task to render a dashboard to a document or image. Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\RenderTaskApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$dashboard_id = "dashboard_id_example"; // string | Id of dashboard to render. The ID can be a LookML dashboard also.
$result_format = "result_format_example"; // string | Output type: pdf, png, or jpg
$body = new \Swagger\Client\Model\CreateDashboardRenderTask(); // \Swagger\Client\Model\CreateDashboardRenderTask | Dashboard render task parameters
$width = 789; // int | Output width in pixels
$height = 789; // int | Output height in pixels
$fields = "fields_example"; // string | Requested fields.
$pdf_paper_size = "pdf_paper_size_example"; // string | Paper size for pdf. Value can be one of: [\"letter\",\"legal\",\"tabloid\",\"a0\",\"a1\",\"a2\",\"a3\",\"a4\",\"a5\"]
$pdf_landscape = true; // bool | Whether to render pdf in landscape paper orientation
$long_tables = true; // bool | Whether or not to expand table vis to full length

try {
    $result = $apiInstance->createDashboardRenderTask($dashboard_id, $result_format, $body, $width, $height, $fields, $pdf_paper_size, $pdf_landscape, $long_tables);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderTaskApi->createDashboardRenderTask: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
dashboard_id string Id of dashboard to render. The ID can be a LookML dashboard also.
result_format string Output type: pdf, png, or jpg
body \Swagger\Client\Model\CreateDashboardRenderTask Dashboard render task parameters
width int Output width in pixels
height int Output height in pixels
fields string Requested fields. [optional]
pdf_paper_size string Paper size for pdf. Value can be one of: [&quot;letter&quot;,&quot;legal&quot;,&quot;tabloid&quot;,&quot;a0&quot;,&quot;a1&quot;,&quot;a2&quot;,&quot;a3&quot;,&quot;a4&quot;,&quot;a5&quot;] [optional]
pdf_landscape bool Whether to render pdf in landscape paper orientation [optional]
long_tables bool Whether or not to expand table vis to full length [optional]

Return type

\Swagger\Client\Model\RenderTask

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createLookRenderTask

\Swagger\Client\Model\RenderTask createLookRenderTask($look_id, $result_format, $width, $height, $fields)

Create Look Render Task

Create a new task to render a look to an image. Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\RenderTaskApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$look_id = "look_id_example"; // string | Id of look to render
$result_format = "result_format_example"; // string | Output type: png, or jpg
$width = 789; // int | Output width in pixels
$height = 789; // int | Output height in pixels
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createLookRenderTask($look_id, $result_format, $width, $height, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderTaskApi->createLookRenderTask: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
look_id string Id of look to render
result_format string Output type: png, or jpg
width int Output width in pixels
height int Output height in pixels
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\RenderTask

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createQueryRenderTask

\Swagger\Client\Model\RenderTask createQueryRenderTask($query_id, $result_format, $width, $height, $fields)

Create Query Render Task

Create a new task to render an existing query to an image. Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\RenderTaskApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$query_id = "query_id_example"; // string | Id of the query to render
$result_format = "result_format_example"; // string | Output type: png or jpg
$width = 789; // int | Output width in pixels
$height = 789; // int | Output height in pixels
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->createQueryRenderTask($query_id, $result_format, $width, $height, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderTaskApi->createQueryRenderTask: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
query_id string Id of the query to render
result_format string Output type: png or jpg
width int Output width in pixels
height int Output height in pixels
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\RenderTask

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

renderTask

\Swagger\Client\Model\RenderTask renderTask($render_task_id, $fields)

Get Render Task

Get information about a render task. Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\RenderTaskApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$render_task_id = "render_task_id_example"; // string | Id of render task
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->renderTask($render_task_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderTaskApi->renderTask: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
render_task_id string Id of render task
fields string Requested fields. [optional]

Return type

\Swagger\Client\Model\RenderTask

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

renderTaskResults

string renderTaskResults($render_task_id)

Render Task Results

Get the document or image produced by a completed render task. Note that the PDF or image result will be a binary blob in the HTTP response, as indicated by the Content-Type in the response headers. This may require specialized (or at least different) handling than text responses such as JSON. You may need to tell your HTTP client that the response is binary so that it does not attempt to parse the binary data as text. If the render task exists but has not finished rendering the results, the response HTTP status will be 202 Accepted, the response body will be empty, and the response will have a Retry-After header indicating that the caller should repeat the request at a later time. Returns 404 if the render task cannot be found, if the cached result has expired, or if the caller does not have permission to view the results. For detailed information about the status of the render task, use Render Task. Polling loops waiting for completion of a render task would be better served by polling render_task(id) until the task status reaches completion (or error) instead of polling render_task_results(id) alone.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\RenderTaskApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$render_task_id = "render_task_id_example"; // string | Id of render task

try {
    $result = $apiInstance->renderTaskResults($render_task_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderTaskApi->renderTaskResults: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
render_task_id string Id of render task

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: image/jpeg, image/png, application/pdf

[Back to top] [Back to API list] [Back to Model list] [Back to README]