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

Latest commit

 

History

History
530 lines (376 loc) · 16.2 KB

HomepageApi.md

File metadata and controls

530 lines (376 loc) · 16.2 KB

Looker\HomepageApi

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

Method HTTP request Description
allHomepageItems GET /homepage_items Get All Homepage Items
allHomepageSections GET /homepage_sections Get All Homepage sections
createHomepageItem POST /homepage_items Create Homepage Item
createHomepageSection POST /homepage_sections Create Homepage section
deleteHomepageItem DELETE /homepage_items/{homepage_item_id} Delete Homepage Item
deleteHomepageSection DELETE /homepage_sections/{homepage_section_id} Delete Homepage section
homepageItem GET /homepage_items/{homepage_item_id} Get Homepage Item
homepageSection GET /homepage_sections/{homepage_section_id} Get Homepage section
updateHomepageItem PATCH /homepage_items/{homepage_item_id} Update Homepage Item
updateHomepageSection PATCH /homepage_sections/{homepage_section_id} Update Homepage section

allHomepageItems

\Looker\Model\HomepageItem[] allHomepageItems($fields, $sorts, $homepage_section_id)

Get All Homepage Items

Get information about all homepage items.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$sorts = "sorts_example"; // string | Fields to sort by.
$homepage_section_id = "homepage_section_id_example"; // string | Filter to a specific homepage section

try {
    $result = $apiInstance->allHomepageItems($fields, $sorts, $homepage_section_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomepageApi->allHomepageItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fields string Requested fields. [optional]
sorts string Fields to sort by. [optional]
homepage_section_id string Filter to a specific homepage section [optional]

Return type

\Looker\Model\HomepageItem[]

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]

allHomepageSections

\Looker\Model\HomepageSection[] allHomepageSections($fields, $sorts)

Get All Homepage sections

Get information about all homepage sections.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$sorts = "sorts_example"; // string | Fields to sort by.

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

Parameters

Name Type Description Notes
fields string Requested fields. [optional]
sorts string Fields to sort by. [optional]

Return type

\Looker\Model\HomepageSection[]

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]

createHomepageItem

\Looker\Model\HomepageItem createHomepageItem($body, $fields)

Create Homepage Item

Create a new homepage item.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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\HomepageItem(); // \Looker\Model\HomepageItem | Homepage Item
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
body \Looker\Model\HomepageItem Homepage Item [optional]
fields string Requested fields. [optional]

Return type

\Looker\Model\HomepageItem

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]

createHomepageSection

\Looker\Model\HomepageSection createHomepageSection($body, $fields)

Create Homepage section

Create a new homepage section.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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\HomepageSection(); // \Looker\Model\HomepageSection | Homepage section
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
body \Looker\Model\HomepageSection Homepage section [optional]
fields string Requested fields. [optional]

Return type

\Looker\Model\HomepageSection

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]

deleteHomepageItem

string deleteHomepageItem($homepage_item_id)

Delete Homepage Item

Delete a homepage item.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$homepage_item_id = 789; // int | Id of homepage_item

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

Parameters

Name Type Description Notes
homepage_item_id int Id of homepage_item

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]

deleteHomepageSection

string deleteHomepageSection($homepage_section_id)

Delete Homepage section

Delete a homepage section.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$homepage_section_id = 789; // int | Id of homepage_section

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

Parameters

Name Type Description Notes
homepage_section_id int Id of homepage_section

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]

homepageItem

\Looker\Model\HomepageItem homepageItem($homepage_item_id, $fields)

Get Homepage Item

Get information about a homepage item.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$homepage_item_id = 789; // int | Id of homepage item
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
homepage_item_id int Id of homepage item
fields string Requested fields. [optional]

Return type

\Looker\Model\HomepageItem

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]

homepageSection

\Looker\Model\HomepageSection homepageSection($homepage_section_id, $fields)

Get Homepage section

Get information about a homepage section.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$homepage_section_id = 789; // int | Id of homepage section
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
homepage_section_id int Id of homepage section
fields string Requested fields. [optional]

Return type

\Looker\Model\HomepageSection

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]

updateHomepageItem

\Looker\Model\HomepageItem updateHomepageItem($homepage_item_id, $body, $fields)

Update Homepage Item

Update a homepage item definition.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$homepage_item_id = 789; // int | Id of homepage item
$body = new \Looker\Model\HomepageItem(); // \Looker\Model\HomepageItem | Homepage Item
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
homepage_item_id int Id of homepage item
body \Looker\Model\HomepageItem Homepage Item
fields string Requested fields. [optional]

Return type

\Looker\Model\HomepageItem

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]

updateHomepageSection

\Looker\Model\HomepageSection updateHomepageSection($homepage_section_id, $body, $fields)

Update Homepage section

Update a homepage section definition.

Example

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

$apiInstance = new Looker\Api\HomepageApi(
    // 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()
);
$homepage_section_id = 789; // int | Id of homepage section
$body = new \Looker\Model\HomepageSection(); // \Looker\Model\HomepageSection | Homepage section
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
homepage_section_id int Id of homepage section
body \Looker\Model\HomepageSection Homepage section
fields string Requested fields. [optional]

Return type

\Looker\Model\HomepageSection

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]