Looker\ScheduledPlanApi

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

Method	HTTP request	Description
allScheduledPlans	GET /scheduled_plans	Get All Scheduled Plans
createScheduledPlan	POST /scheduled_plans	Create Scheduled Plan
deleteScheduledPlan	DELETE /scheduled_plans/{scheduled_plan_id}	Delete Scheduled Plan
scheduledPlan	GET /scheduled_plans/{scheduled_plan_id}	Get Scheduled Plan
scheduledPlanRunOnce	POST /scheduled_plans/run_once	Run Scheduled Plan Once
scheduledPlansForDashboard	GET /scheduled_plans/dashboard/{dashboard_id}	Scheduled Plans for Dashboard
scheduledPlansForLook	GET /scheduled_plans/look/{look_id}	Scheduled Plans for Look
scheduledPlansForLookmlDashboard	GET /scheduled_plans/lookml_dashboard/{lookml_dashboard_id}	Scheduled Plans for LookML Dashboard
scheduledPlansForSpace	GET /scheduled_plans/space/{space_id}	Scheduled Plans for Space
updateScheduledPlan	PATCH /scheduled_plans/{scheduled_plan_id}	Update Scheduled Plan

allScheduledPlans

\Looker\Model\ScheduledPlan[] allScheduledPlans($user_id, $fields)

Get All Scheduled Plans

List all scheduled plans which belong to the requesting user

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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()
);
$user_id = 789; // int | User Id (default is requesting user if not specified)
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
user_id	int	User Id (default is requesting user if not specified)	[optional]
fields	string	Requested fields.	[optional]

Return type

\Looker\Model\ScheduledPlan[]

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]

createScheduledPlan

\Looker\Model\ScheduledPlan createScheduledPlan($body)

Create Scheduled Plan

Schedule a Look or Dashboard by creating a scheduled plan. Admins can create scheduled plans on behalf of other users by specifying a user id.

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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\ScheduledPlan(); // \Looker\Model\ScheduledPlan | Scheduled Plan

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

Parameters

Name	Type	Description	Notes
body	\Looker\Model\ScheduledPlan	Scheduled Plan	[optional]

Return type

\Looker\Model\ScheduledPlan

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]

deleteScheduledPlan

string deleteScheduledPlan($scheduled_plan_id)

Delete Scheduled Plan

Delete the scheduled plan with the specified id. Admins can delete other users' Scheduled Plans.

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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()
);
$scheduled_plan_id = 789; // int | Scheduled Plan Id

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

Parameters

Name	Type	Description	Notes
scheduled_plan_id	int	Scheduled Plan Id

Return type

string

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]

scheduledPlan

\Looker\Model\ScheduledPlan scheduledPlan($scheduled_plan_id, $fields)

Get Scheduled Plan

Get information about a scheduled plan. Admins can fetch information about other users' Scheduled Plans.

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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()
);
$scheduled_plan_id = 789; // int | Scheduled Plan Id
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
scheduled_plan_id	int	Scheduled Plan Id
fields	string	Requested fields.	[optional]

Return type

\Looker\Model\ScheduledPlan

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]

scheduledPlanRunOnce

\Looker\Model\ScheduledPlan scheduledPlanRunOnce($body)

Run Scheduled Plan Once

Schedule a Look or Dashboard to run once now with a scheduled plan. This can be useful for testing a Scheduled Plan before committing to a production schedule. Admins can create scheduled plans on behalf of other users by specifying a user id.

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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\ScheduledPlan(); // \Looker\Model\ScheduledPlan | Scheduled Plan

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

Parameters

Name	Type	Description	Notes
body	\Looker\Model\ScheduledPlan	Scheduled Plan	[optional]

Return type

\Looker\Model\ScheduledPlan

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]

scheduledPlansForDashboard

\Looker\Model\ScheduledPlan[] scheduledPlansForDashboard($dashboard_id, $user_id, $fields)

Scheduled Plans for Dashboard

Get scheduled plans by using a dashboard id for the requesting user or a specified user id (with :see_schedules permission)

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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 = 789; // int | Dashboard Id
$user_id = 789; // int | User Id (default is requesting user if not specified)
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->scheduledPlansForDashboard($dashboard_id, $user_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForDashboard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
dashboard_id	int	Dashboard Id
user_id	int	User Id (default is requesting user if not specified)	[optional]
fields	string	Requested fields.	[optional]

Return type

\Looker\Model\ScheduledPlan[]

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]

scheduledPlansForLook

\Looker\Model\ScheduledPlan[] scheduledPlansForLook($look_id, $user_id, $fields)

Scheduled Plans for Look

Get scheduled plans by using a look id for the requesting user or a specified user id (with :see_schedules permission)

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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 = 789; // int | Look Id
$user_id = 789; // int | User Id (default is requesting user if not specified)
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->scheduledPlansForLook($look_id, $user_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForLook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
look_id	int	Look Id
user_id	int	User Id (default is requesting user if not specified)	[optional]
fields	string	Requested fields.	[optional]

Return type

\Looker\Model\ScheduledPlan[]

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]

scheduledPlansForLookmlDashboard

\Looker\Model\ScheduledPlan[] scheduledPlansForLookmlDashboard($lookml_dashboard_id, $user_id, $fields)

Scheduled Plans for LookML Dashboard

Get scheduled plans by using a LookML dashboard id for the requesting user or a specified user id (with :see_schedules permission)

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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()
);
$lookml_dashboard_id = 789; // int | LookML Dashboard Id
$user_id = 789; // int | User Id (default is requesting user if not specified)
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->scheduledPlansForLookmlDashboard($lookml_dashboard_id, $user_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForLookmlDashboard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lookml_dashboard_id	int	LookML Dashboard Id
user_id	int	User Id (default is requesting user if not specified)	[optional]
fields	string	Requested fields.	[optional]

Return type

\Looker\Model\ScheduledPlan[]

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]

scheduledPlansForSpace

\Looker\Model\ScheduledPlan[] scheduledPlansForSpace($space_id, $fields)

Scheduled Plans for Space

Get scheduled plans by using a space id for the requesting user.

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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()
);
$space_id = 789; // int | Space Id
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
space_id	int	Space Id
fields	string	Requested fields.	[optional]

Return type

\Looker\Model\ScheduledPlan[]

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]

updateScheduledPlan

\Looker\Model\ScheduledPlan updateScheduledPlan($scheduled_plan_id, $body)

Update Scheduled Plan

Update the scheduled plan with the specified id. Admins can update other users' Scheduled Plans.

Example

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

$apiInstance = new Looker\Api\ScheduledPlanApi(
    // 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()
);
$scheduled_plan_id = 789; // int | Scheduled Plan Id
$body = new \Looker\Model\ScheduledPlan(); // \Looker\Model\ScheduledPlan | Scheduled Plan

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

Parameters

Name	Type	Description	Notes
scheduled_plan_id	int	Scheduled Plan Id
body	\Looker\Model\ScheduledPlan	Scheduled Plan

Return type

\Looker\Model\ScheduledPlan

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]

Files

ScheduledPlanApi.md

Latest commit

History

ScheduledPlanApi.md

File metadata and controls

Looker\ScheduledPlanApi

allScheduledPlans

List all scheduled plans which belong to the requesting user

Example

Parameters

Return type

Authorization

HTTP request headers

createScheduledPlan

Schedule a Look or Dashboard by creating a scheduled plan. Admins can create scheduled plans on behalf of other users by specifying a user id.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteScheduledPlan

Delete the scheduled plan with the specified id. Admins can delete other users' Scheduled Plans.

Example

Parameters

Return type

Authorization

HTTP request headers

scheduledPlan

Get information about a scheduled plan. Admins can fetch information about other users' Scheduled Plans.

Example

Parameters

Return type

Authorization

HTTP request headers

scheduledPlanRunOnce

Schedule a Look or Dashboard to run once now with a scheduled plan. This can be useful for testing a Scheduled Plan before committing to a production schedule. Admins can create scheduled plans on behalf of other users by specifying a user id.

Example

Parameters

Return type

Authorization

HTTP request headers

scheduledPlansForDashboard

Get scheduled plans by using a dashboard id for the requesting user or a specified user id (with :see_schedules permission)

Example

Parameters

Return type

Authorization

HTTP request headers

scheduledPlansForLook

Get scheduled plans by using a look id for the requesting user or a specified user id (with :see_schedules permission)

Example

Parameters

Return type

Authorization

HTTP request headers

scheduledPlansForLookmlDashboard

Get scheduled plans by using a LookML dashboard id for the requesting user or a specified user id (with :see_schedules permission)

Example

Parameters

Return type

Authorization

HTTP request headers

scheduledPlansForSpace

Get scheduled plans by using a space id for the requesting user.

Example

Parameters

Return type

Authorization

HTTP request headers

updateScheduledPlan

Update the scheduled plan with the specified id. Admins can update other users' Scheduled Plans.

Example

Parameters

Return type

Authorization

HTTP request headers