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

Latest commit

 

History

History
650 lines (466 loc) · 21.3 KB

ContentApi.md

File metadata and controls

650 lines (466 loc) · 21.3 KB

Looker\ContentApi

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

Method HTTP request Description
allContentMetadataAccesss GET /content_metadata_access Get All Content Metadata Accesss
allContentMetadatas GET /content_metadata Get All Content Metadatas
contentFavorite GET /content_favorite/{content_favorite_id} Get Favorite Content
contentMetadata GET /content_metadata/{content_metadata_id} Get Content Metadata
createContentFavorite POST /content_favorite Create Favorite Content
createContentMetadataAccess POST /content_metadata_access Create Content Metadata Access
deleteContentFavorite DELETE /content_favorite/{content_favorite_id} Delete Favorite Content
deleteContentMetadataAccess DELETE /content_metadata_access/{content_metadata_access_id} Delete Content Metadata Access
searchContentFavorites GET /content_favorite/search Search Favorite Contents
searchContentViews GET /content_view/search Search Content Views
updateContentMetadata PATCH /content_metadata/{content_metadata_id} Update Content Metadata
updateContentMetadataAccess PUT /content_metadata_access/{content_metadata_access_id} Update Content Metadata Access

allContentMetadataAccesss

\Looker\Model\ContentMetaGroupUser[] allContentMetadataAccesss($content_metadata_id, $fields)

Get All Content Metadata Accesss

All content metadata access records for a content metadata item.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_metadata_id = 789; // int | Id of content metadata
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
content_metadata_id int Id of content metadata [optional]
fields string Requested fields. [optional]

Return type

\Looker\Model\ContentMetaGroupUser[]

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]

allContentMetadatas

\Looker\Model\ContentMeta[] allContentMetadatas($parent_id, $fields)

Get All Content Metadatas

Get information about all content metadata in a space.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$parent_id = 789; // int | Parent space of content.
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
parent_id int Parent space of content.
fields string Requested fields. [optional]

Return type

\Looker\Model\ContentMeta[]

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]

contentFavorite

\Looker\Model\ContentFavorite contentFavorite($content_favorite_id, $fields)

Get Favorite Content

Get favorite content by its id

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_favorite_id = 789; // int | Id of favorite content
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
content_favorite_id int Id of favorite content
fields string Requested fields. [optional]

Return type

\Looker\Model\ContentFavorite

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]

contentMetadata

\Looker\Model\ContentMeta contentMetadata($content_metadata_id, $fields)

Get Content Metadata

Get information about an individual content metadata record.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_metadata_id = 789; // int | Id of content metadata
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name Type Description Notes
content_metadata_id int Id of content metadata
fields string Requested fields. [optional]

Return type

\Looker\Model\ContentMeta

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]

createContentFavorite

\Looker\Model\ContentFavorite createContentFavorite($body)

Create Favorite Content

Create favorite content

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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\ContentFavorite(); // \Looker\Model\ContentFavorite | Favorite Content

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

Parameters

Name Type Description Notes
body \Looker\Model\ContentFavorite Favorite Content [optional]

Return type

\Looker\Model\ContentFavorite

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]

createContentMetadataAccess

\Looker\Model\ContentMetaGroupUser createContentMetadataAccess($body)

Create Content Metadata Access

Create content metadata access.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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\ContentMetaGroupUser(); // \Looker\Model\ContentMetaGroupUser | Content Metadata Access

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

Parameters

Name Type Description Notes
body \Looker\Model\ContentMetaGroupUser Content Metadata Access [optional]

Return type

\Looker\Model\ContentMetaGroupUser

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]

deleteContentFavorite

string deleteContentFavorite($content_favorite_id)

Delete Favorite Content

Delete favorite content

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_favorite_id = 789; // int | Id of favorite content

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

Parameters

Name Type Description Notes
content_favorite_id int Id of favorite content

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]

deleteContentMetadataAccess

string deleteContentMetadataAccess($content_metadata_access_id)

Delete Content Metadata Access

Remove content metadata access.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_metadata_access_id = 789; // int | Id of content metadata access

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

Parameters

Name Type Description Notes
content_metadata_access_id int Id of content metadata access

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]

searchContentFavorites

\Looker\Model\ContentFavorite[] searchContentFavorites($user_id, $limit, $offset, $sorts, $fields)

Search Favorite Contents

Search Favorite Content

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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 | Match User Id
$limit = 789; // int | Number of results to return. (used with offset)
$offset = 789; // int | Number of results to skip before returning any. (used with limit)
$sorts = "sorts_example"; // string | Fields to sort by.
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->searchContentFavorites($user_id, $limit, $offset, $sorts, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->searchContentFavorites: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_id int Match User Id [optional]
limit int Number of results to return. (used with offset) [optional]
offset int Number of results to skip before returning any. (used with limit) [optional]
sorts string Fields to sort by. [optional]
fields string Requested fields. [optional]

Return type

\Looker\Model\ContentFavorite[]

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]

searchContentViews

\Looker\Model\ContentView[] searchContentViews($view_count, $group_id, $look_id, $dashboard_id, $content_metadata_id, $start_of_week_date, $all_time, $user_id, $limit, $offset, $sorts, $fields)

Search Content Views

Search Content View

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$view_count = 789; // int | Match view count
$group_id = 789; // int | Match Group Id
$look_id = "look_id_example"; // string | Match look_id
$dashboard_id = "dashboard_id_example"; // string | Match dashboard_id
$content_metadata_id = 789; // int | Match content metadata id
$start_of_week_date = "start_of_week_date_example"; // string | Match start of week date
$all_time = true; // bool | True if only all time view records should be returned
$user_id = 789; // int | Match user id
$limit = 789; // int | Number of results to return. Use with `offset` to manage pagination of results
$offset = 789; // int | Number of results to skip before returning data
$sorts = "sorts_example"; // string | Fields to sort by
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->searchContentViews($view_count, $group_id, $look_id, $dashboard_id, $content_metadata_id, $start_of_week_date, $all_time, $user_id, $limit, $offset, $sorts, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->searchContentViews: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
view_count int Match view count [optional]
group_id int Match Group Id [optional]
look_id string Match look_id [optional]
dashboard_id string Match dashboard_id [optional]
content_metadata_id int Match content metadata id [optional]
start_of_week_date string Match start of week date [optional]
all_time bool True if only all time view records should be returned [optional]
user_id int Match user id [optional]
limit int Number of results to return. Use with `offset` to manage pagination of results [optional]
offset int Number of results to skip before returning data [optional]
sorts string Fields to sort by [optional]
fields string Requested fields. [optional]

Return type

\Looker\Model\ContentView[]

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]

updateContentMetadata

\Looker\Model\ContentMeta updateContentMetadata($content_metadata_id, $body)

Update Content Metadata

Move a piece of content.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_metadata_id = 789; // int | Id of content metadata
$body = new \Looker\Model\ContentMeta(); // \Looker\Model\ContentMeta | Content Metadata

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

Parameters

Name Type Description Notes
content_metadata_id int Id of content metadata
body \Looker\Model\ContentMeta Content Metadata

Return type

\Looker\Model\ContentMeta

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]

updateContentMetadataAccess

\Looker\Model\ContentMetaGroupUser updateContentMetadataAccess($content_metadata_access_id, $body)

Update Content Metadata Access

Update type of access for content metadata.

Example

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

$apiInstance = new Looker\Api\ContentApi(
    // 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()
);
$content_metadata_access_id = 789; // int | Id of content metadata access
$body = new \Looker\Model\ContentMetaGroupUser(); // \Looker\Model\ContentMetaGroupUser | Content Metadata Access

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

Parameters

Name Type Description Notes
content_metadata_access_id int Id of content metadata access
body \Looker\Model\ContentMetaGroupUser Content Metadata Access

Return type

\Looker\Model\ContentMetaGroupUser

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]