KeywordApi.md

Dcm\KeywordApi

All URIs are relative to https://dcmapi.dolead.com/v1

Method	HTTP request	Description
controllersKeywordKeywordList	GET /keyword	List keywords matching given criteria

controllersKeywordKeywordList

\Dcm\Model\Keyword[] controllersKeywordKeywordList($body, $limit, $offset)

List keywords matching given criteria

Each criterion may be an Enum or a TextParameter
- An Enum parameter is a simple string but which cannot take random values
- A TextParameter describe a query over a text field. Query is defined as an object of operator -> value. Multiple operators may be specified in the query, but only one of each kind (For example, a contains operator can be combined with a not_contains operator)

Example

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

// Configure API key authorization: api_key
Dcm\Configuration::getDefaultConfiguration()->setApiKey('DCM-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Dcm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('DCM-API-KEY', 'Bearer');

$api_instance = new Dcm\Api\KeywordApi();
$body = new \Dcm\Model\KeywordQuery(); // \Dcm\Model\KeywordQuery | 
$limit = 100; // int | Number of keywords returned. Used in pagination
$offset = 0; // int | Pagination offset

try {
    $result = $api_instance->controllersKeywordKeywordList($body, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KeywordApi->controllersKeywordKeywordList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Dcm\Model\KeywordQuery		[optional]
limit	int	Number of keywords returned. Used in pagination	[optional] [default to 100]
offset	int	Pagination offset	[optional] [default to 0]

Return type

\Dcm\Model\Keyword[]

Authorization

api_key

HTTP request headers

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

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