Skip to content
This repository has been archived by the owner on Jul 8, 2020. It is now read-only.

Latest commit

 

History

History
108 lines (74 loc) · 3.41 KB

DataActionApi.md

File metadata and controls

108 lines (74 loc) · 3.41 KB

Looker\DataActionApi

All URIs are relative to https://ethosce.looker.com:19999/api/3.1

Method HTTP request Description
fetchRemoteDataActionForm POST /data_actions/form Fetch Remote Data Action Form
performDataAction POST /data_actions Send a Data Action

fetchRemoteDataActionForm

\Looker\Model\DataActionForm fetchRemoteDataActionForm($body)

Fetch Remote Data Action Form

For some data actions, the remote server may supply a form requesting further user input. This endpoint takes a data action, asks the remote server to generate a form for it, and returns that form to you for presentation to the user.

Example

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

$apiInstance = new Looker\Api\DataActionApi(
    // 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()
);
$body = new \stdClass; // object | Data Action Request

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

Parameters

Name Type Description Notes
body object Data Action Request

Return type

\Looker\Model\DataActionForm

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]

performDataAction

\Looker\Model\DataActionResponse performDataAction($body)

Send a Data Action

Perform a data action. The data action object can be obtained from query results, and used to perform an arbitrary action.

Example

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

$apiInstance = new Looker\Api\DataActionApi(
    // 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()
);
$body = new \Looker\Model\DataActionRequest(); // \Looker\Model\DataActionRequest | Data Action Request

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

Parameters

Name Type Description Notes
body \Looker\Model\DataActionRequest Data Action Request

Return type

\Looker\Model\DataActionResponse

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]