TagApi.md

Swagger\Client\TagApi

All URIs are relative to /

Method	HTTP request	Description
deleteDeleteTag	DELETE /api/tags/{id}	Delete a tag
getGetTags	GET /api/tags	Deprecated: Fetch tags by filter as string collection
getGetTagsFull	GET /api/tags/find	Fetch tags by filter (as full entities)
postPostTag	POST /api/tags	Creates a new tag

deleteDeleteTag

deleteDeleteTag($id)

Delete a tag

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\TagApi(
    // 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(),
    $config
);
$id = "id_example"; // string | Tag ID to delete

try {
    $apiInstance->deleteDeleteTag($id);
} catch (Exception $e) {
    echo 'Exception when calling TagApi->deleteDeleteTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Tag ID to delete

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

getGetTags

string[] getGetTags($name)

Deprecated: Fetch tags by filter as string collection

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\TagApi(
    // 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(),
    $config
);
$name = "name_example"; // string | Search term to filter tag list

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

Parameters

Name	Type	Description	Notes
name	string	Search term to filter tag list	[optional]

Return type

string[]

Authorization

bearer

HTTP request headers

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

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

getGetTagsFull

\Swagger\Client\Model\TagEntity[] getGetTagsFull($name)

Fetch tags by filter (as full entities)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\TagApi(
    // 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(),
    $config
);
$name = "name_example"; // string | Search term to filter tag list

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

Parameters

Name	Type	Description	Notes
name	string	Search term to filter tag list	[optional]

Return type

\Swagger\Client\Model\TagEntity[]

Authorization

bearer

HTTP request headers

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

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

postPostTag

\Swagger\Client\Model\TagEntity postPostTag($body)

Creates a new tag

Creates a new tag and returns it afterwards

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\TagApi(
    // 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(),
    $config
);
$body = new \Swagger\Client\Model\TagEditForm(); // \Swagger\Client\Model\TagEditForm | 

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\TagEditForm

Return type

\Swagger\Client\Model\TagEntity

Authorization

bearer

HTTP request headers

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

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