Swagger-generated docs for Looker ScheduledPlanApi

ScheduledPlanApi.md

Swagger\Client\ScheduledPlanApi

All URIs are relative to https://nysenate.looker.com:19999/api/3.0

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	Create Scheduled Plan
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

\Swagger\Client\Model\ScheduledPlan[] allScheduledPlans($user_id)

Get All Scheduled Plans

List all scheduled plans which belong to the requesting user

Example

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

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$user_id = 789; // int | User Id (default is requesting user if not specified)

try { 
    $result = $api_instance->allScheduledPlans($user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->allScheduledPlans: ', $e->getMessage(), "\n";
}
?>

Parameters

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

Return type

\Swagger\Client\Model\ScheduledPlan[]

Authorization

No authorization required

HTTP reuqest headers

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

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

createScheduledPlan

\Swagger\Client\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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$body = new \Swagger\Client\Model\ScheduledPlan(); // \Swagger\Client\Model\ScheduledPlan | Scheduled Plan

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

Parameters

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

Return type

\Swagger\Client\Model\ScheduledPlan

Authorization

No authorization required

HTTP reuqest 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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$scheduled_plan_id = 789; // int | Scheduled Plan Id

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

Parameters

Name	Type	Description	Notes
scheduled_plan_id	int	Scheduled Plan Id

Return type

string

Authorization

No authorization required

HTTP reuqest headers

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

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

scheduledPlan

\Swagger\Client\Model\ScheduledPlan scheduledPlan($scheduled_plan_id)

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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$scheduled_plan_id = 789; // int | Scheduled Plan Id

try { 
    $result = $api_instance->scheduledPlan($scheduled_plan_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlan: ', $e->getMessage(), "\n";
}
?>

Parameters

Name	Type	Description	Notes
scheduled_plan_id	int	Scheduled Plan Id

Return type

\Swagger\Client\Model\ScheduledPlan

Authorization

No authorization required

HTTP reuqest headers

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

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

scheduledPlanRunOnce

\Swagger\Client\Model\ScheduledPlan scheduledPlanRunOnce($body)

Create Scheduled Plan

Schedule a Look or Dashboard to run once now with a scheduled plan (can be useful for testing 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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$body = new \Swagger\Client\Model\ScheduledPlan(); // \Swagger\Client\Model\ScheduledPlan | Scheduled Plan

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

Parameters

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

Return type

\Swagger\Client\Model\ScheduledPlan

Authorization

No authorization required

HTTP reuqest headers

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

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

scheduledPlansForDashboard

\Swagger\Client\Model\ScheduledPlan[] scheduledPlansForDashboard($dashboard_id, $user_id)

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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$dashboard_id = 789; // int | Dashboard Id
$user_id = 789; // int | User Id (default is requesting user if not specified)

try { 
    $result = $api_instance->scheduledPlansForDashboard($dashboard_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForDashboard: ', $e->getMessage(), "\n";
}
?>

Parameters

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

Return type

\Swagger\Client\Model\ScheduledPlan[]

Authorization

No authorization required

HTTP reuqest headers

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

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

scheduledPlansForLook

\Swagger\Client\Model\ScheduledPlan[] scheduledPlansForLook($look_id, $user_id)

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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$look_id = 789; // int | Look Id
$user_id = 789; // int | User Id (default is requesting user if not specified)

try { 
    $result = $api_instance->scheduledPlansForLook($look_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForLook: ', $e->getMessage(), "\n";
}
?>

Parameters

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

Return type

\Swagger\Client\Model\ScheduledPlan[]

Authorization

No authorization required

HTTP reuqest headers

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

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

scheduledPlansForLookmlDashboard

\Swagger\Client\Model\ScheduledPlan[] scheduledPlansForLookmlDashboard($lookml_dashboard_id, $user_id)

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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$lookml_dashboard_id = 789; // int | LookML Dashboard Id
$user_id = 789; // int | User Id (default is requesting user if not specified)

try { 
    $result = $api_instance->scheduledPlansForLookmlDashboard($lookml_dashboard_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForLookmlDashboard: ', $e->getMessage(), "\n";
}
?>

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]

Return type

\Swagger\Client\Model\ScheduledPlan[]

Authorization

No authorization required

HTTP reuqest headers

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

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

scheduledPlansForSpace

\Swagger\Client\Model\ScheduledPlan[] scheduledPlansForSpace($space_id)

Scheduled Plans for Space

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

Example

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

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$space_id = 789; // int | Space Id

try { 
    $result = $api_instance->scheduledPlansForSpace($space_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScheduledPlanApi->scheduledPlansForSpace: ', $e->getMessage(), "\n";
}
?>

Parameters

Name	Type	Description	Notes
space_id	int	Space Id

Return type

\Swagger\Client\Model\ScheduledPlan[]

Authorization

No authorization required

HTTP reuqest headers

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

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

updateScheduledPlan

\Swagger\Client\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');

$api_instance = new Swagger\Client\Api\ScheduledPlanApi();
$scheduled_plan_id = 789; // int | Scheduled Plan Id
$body = new \Swagger\Client\Model\ScheduledPlan(); // \Swagger\Client\Model\ScheduledPlan | Scheduled Plan

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

Parameters

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

Return type

\Swagger\Client\Model\ScheduledPlan

Authorization

No authorization required

HTTP reuqest headers

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

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