Swagger\Client\TagApi

All URIs are relative to https://atlas.forsta.io/v1

Method	HTTP request	Description
tagCreate	POST /tag/
tagDelete	DELETE /tag/{id}/
tagList	GET /tag/
tagPartialUpdate	PATCH /tag/{id}/
tagRead	GET /tag/{id}/
tagUpdate	PUT /tag/{id}/

tagCreate

\Swagger\Client\Model\Tag tagCreate($data)

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$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
);
$data = new \Swagger\Client\Model\Tag(); // \Swagger\Client\Model\Tag | 

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

Parameters

Name	Type	Description	Notes
data	\Swagger\Client\Model\Tag

Return type

\Swagger\Client\Model\Tag

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

tagDelete

tagDelete($id)

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$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 | A UUID string identifying this tag.

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

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this tag.

Return type

void (empty response body)

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

tagList

\Swagger\Client\Model\InlineResponse2004 tagList($slug, $description, $users, $ordering, $search, $page, $page_size)

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$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
);
$slug = "slug_example"; // string | 
$description = "description_example"; // string | 
$users = "users_example"; // string | 
$ordering = "ordering_example"; // string | Which field to use when ordering the results.
$search = "search_example"; // string | A search term.
$page = 56; // int | A page number within the paginated result set.
$page_size = 56; // int | Number of results to return per page.

try {
    $result = $apiInstance->tagList($slug, $description, $users, $ordering, $search, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TagApi->tagList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
slug	string		[optional]
description	string		[optional]
users	string		[optional]
ordering	string	Which field to use when ordering the results.	[optional]
search	string	A search term.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]

Return type

\Swagger\Client\Model\InlineResponse2004

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

tagPartialUpdate

\Swagger\Client\Model\Tag tagPartialUpdate($id, $data)

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$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 | A UUID string identifying this tag.
$data = new \Swagger\Client\Model\Tag(); // \Swagger\Client\Model\Tag | 

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

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this tag.
data	\Swagger\Client\Model\Tag

Return type

\Swagger\Client\Model\Tag

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

tagRead

\Swagger\Client\Model\Tag tagRead($id)

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$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 | A UUID string identifying this tag.

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

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this tag.

Return type

\Swagger\Client\Model\Tag

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

tagUpdate

\Swagger\Client\Model\Tag tagUpdate($id, $data)

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$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 | A UUID string identifying this tag.
$data = new \Swagger\Client\Model\Tag(); // \Swagger\Client\Model\Tag | 

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

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this tag.
data	\Swagger\Client\Model\Tag

Return type

\Swagger\Client\Model\Tag

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

Files

TagApi.md

Latest commit

History

TagApi.md

File metadata and controls

Swagger\Client\TagApi

tagCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tagDelete

Example

Parameters

Return type

Authorization

HTTP request headers

tagList

Example

Parameters

Return type

Authorization

HTTP request headers

tagPartialUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

tagRead

Example

Parameters

Return type

Authorization

HTTP request headers

tagUpdate

Example

Parameters

Return type

Authorization

HTTP request headers