Skip to content

Latest commit

 

History

History
243 lines (167 loc) · 7.74 KB

UsertagApi.md

File metadata and controls

243 lines (167 loc) · 7.74 KB

Swagger\Client\UsertagApi

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

Method HTTP request Description
usertagCreate POST /usertag/
usertagDelete DELETE /usertag/{id}/
usertagList GET /usertag/
usertagRead GET /usertag/{id}/

usertagCreate

\Swagger\Client\Model\UserTag usertagCreate($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\UsertagApi(
    // 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\UserTag(); // \Swagger\Client\Model\UserTag | 

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

Parameters

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

Return type

\Swagger\Client\Model\UserTag

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]

usertagDelete

usertagDelete($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\UsertagApi(
    // 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 user tag.

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

Parameters

Name Type Description Notes
id string A UUID string identifying this user 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]

usertagList

\Swagger\Client\Model\InlineResponse2006 usertagList($association_type, $tag_id, $user_id, $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\UsertagApi(
    // 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
);
$association_type = "association_type_example"; // string | 
$tag_id = "tag_id_example"; // string | 
$user_id = "user_id_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->usertagList($association_type, $tag_id, $user_id, $ordering, $search, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsertagApi->usertagList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
association_type string [optional]
tag_id string [optional]
user_id 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\InlineResponse2006

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]

usertagRead

\Swagger\Client\Model\UserTag usertagRead($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\UsertagApi(
    // 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 user tag.

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

Parameters

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

Return type

\Swagger\Client\Model\UserTag

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]