Swagger\Client\ColorCollectionApi

All URIs are relative to https://localhost:20000/api/3.1

Method	HTTP request	Description
allColorCollections	GET /color_collections	Get all Color Collections
colorCollection	GET /color_collections/{collection_id}	Get Color Collection by ID
colorCollectionsCustom	GET /color_collections/custom	Get all Custom Color Collections
colorCollectionsStandard	GET /color_collections/standard	Get all Standard Color Collections
createColorCollection	POST /color_collections	Create ColorCollection
defaultColorCollection	GET /color_collections/default	Get Default Color Collection
deleteColorCollection	DELETE /color_collections/{collection_id}	Delete ColorCollection
setDefaultColorCollection	PUT /color_collections/default	Set Default Color Collection
updateColorCollection	PATCH /color_collections/{collection_id}	Update Custom Color collection

allColorCollections

\Swagger\Client\Model\ColorCollection[] allColorCollections($fields)

Get all Color Collections

Get an array of all existing Color Collections Get a single color collection by id with ColorCollection Get all standard color collections with ColorCollection Get all custom color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ColorCollection[]

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]

colorCollection

\Swagger\Client\Model\ColorCollection colorCollection($collection_id, $fields)

Get Color Collection by ID

Get a Color Collection by ID Use this to retrieve a specific Color Collection. Get a single color collection by id with ColorCollection Get all standard color collections with ColorCollection Get all custom color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$collection_id = "collection_id_example"; // string | Id of Color Collection
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
collection_id	string	Id of Color Collection
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ColorCollection

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]

colorCollectionsCustom

\Swagger\Client\Model\ColorCollection[] colorCollectionsCustom($fields)

Get all Custom Color Collections

Get an array of all existing Custom Color Collections Get a single color collection by id with ColorCollection Get all standard color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ColorCollection[]

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]

colorCollectionsStandard

\Swagger\Client\Model\ColorCollection[] colorCollectionsStandard($fields)

Get all Standard Color Collections

Get an array of all existing Standard Color Collections Get a single color collection by id with ColorCollection Get all custom color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ColorCollection[]

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]

createColorCollection

\Swagger\Client\Model\ColorCollection createColorCollection($body)

Create ColorCollection

Create a custom color collection with the specified information Creates a new custom color collection object, returning the details, including the created id. Update an existing color collection with Update Color Collection Permanently delete an existing custom color collection with Delete Color Collection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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 \Swagger\Client\Model\ColorCollection(); // \Swagger\Client\Model\ColorCollection | ColorCollection

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

Parameters

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

Return type

\Swagger\Client\Model\ColorCollection

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]

defaultColorCollection

\Swagger\Client\Model\ColorCollection defaultColorCollection()

Get Default Color Collection

Get the default color collection Use this to retrieve the default Color Collection. Set the default color collection with ColorCollection

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\ColorCollection

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]

deleteColorCollection

deleteColorCollection($collection_id)

Delete ColorCollection

Delete a custom color collection by id This operation permanently deletes the identified Custom color collection. Standard color collections cannot be deleted Because multiple color collections can have the same label, they must be deleted by ID, not name. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$collection_id = "collection_id_example"; // string | Id of Color Collection

try {
    $apiInstance->deleteColorCollection($collection_id);
} catch (Exception $e) {
    echo 'Exception when calling ColorCollectionApi->deleteColorCollection: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
collection_id	string	Id of Color Collection

Return type

void (empty response body)

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]

setDefaultColorCollection

\Swagger\Client\Model\ColorCollection setDefaultColorCollection($collection_id)

Set Default Color Collection

Set the global default Color Collection by ID Returns the new specified default Color Collection object. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$collection_id = "collection_id_example"; // string | ID of color collection to set as default

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

Parameters

Name	Type	Description	Notes
collection_id	string	ID of color collection to set as default

Return type

\Swagger\Client\Model\ColorCollection

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]

updateColorCollection

\Swagger\Client\Model\ColorCollection updateColorCollection($collection_id, $body)

Update Custom Color collection

Update a custom color collection by id. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Example

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

$apiInstance = new Swagger\Client\Api\ColorCollectionApi(
    // 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()
);
$collection_id = "collection_id_example"; // string | Id of Custom Color Collection
$body = new \Swagger\Client\Model\ColorCollection(); // \Swagger\Client\Model\ColorCollection | ColorCollection

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

Parameters

Name	Type	Description	Notes
collection_id	string	Id of Custom Color Collection
body	\Swagger\Client\Model\ColorCollection	ColorCollection

Return type

\Swagger\Client\Model\ColorCollection

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]

Files

ColorCollectionApi.md

Latest commit

History

ColorCollectionApi.md

File metadata and controls

Swagger\Client\ColorCollectionApi

allColorCollections

Example

Parameters

Return type

Authorization

HTTP request headers

colorCollection

Example

Parameters

Return type

Authorization

HTTP request headers

colorCollectionsCustom

Get an array of all existing Custom Color Collections Get a single color collection by id with ColorCollection Get all standard color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return Not Found (404) errors.

Example

Parameters

Return type

Authorization

HTTP request headers

colorCollectionsStandard

Get an array of all existing Standard Color Collections Get a single color collection by id with ColorCollection Get all custom color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return Not Found (404) errors.

Example

Parameters

Return type

Authorization

HTTP request headers

createColorCollection

Example

Parameters

Return type

Authorization

HTTP request headers

defaultColorCollection

Get the default color collection Use this to retrieve the default Color Collection. Set the default color collection with ColorCollection

Example

Parameters

Return type

Authorization

HTTP request headers

deleteColorCollection

Example

Parameters

Return type

Authorization

HTTP request headers

setDefaultColorCollection

Set the global default Color Collection by ID Returns the new specified default Color Collection object. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return Not Found (404) errors.

Example

Parameters

Return type

Authorization

HTTP request headers

updateColorCollection

Update a custom color collection by id. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return Not Found (404) errors.

Example

Parameters

Return type

Authorization

HTTP request headers

Get an array of all existing Custom Color Collections Get a single color collection by id with ColorCollection Get all standard color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Get an array of all existing Standard Color Collections Get a single color collection by id with ColorCollection Get all custom color collections with ColorCollection Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Set the global default Color Collection by ID Returns the new specified default Color Collection object. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

Update a custom color collection by id. Note: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.