node-red-contrib-knx-ultimate
Version:
Control your KNX and KNX Secure intallation via Node-Red! A bunch of KNX nodes, with integrated Philips HUE control and ETS group address importer. Easy to use and highly configurable.
1,245 lines (1,239 loc) • 2.01 MB
HTML
<!DOCTYPE html>
<!-- saved from url=(0077)https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_get -->
<html class=" gcawjle idc0_350"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Hue CLIP API</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="generator" content="https://github.com/raml2html/raml2html 7.8.0"><link rel="stylesheet" href="./Hue CLIP API_files/bootstrap.min.css"><link rel="stylesheet" href="./Hue CLIP API_files/default.min.css"><script type="text/javascript" src="./Hue CLIP API_files/jquery-3.5.1.min.js"></script><script type="text/javascript" src="./Hue CLIP API_files/bootstrap.min.js"></script><script type="text/javascript" src="./Hue CLIP API_files/highlight.min.js"></script><script type="text/javascript">
$(document).ready(function() {
$('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
// open modal on hashes like #_action_get
$(window).bind('hashchange', function(e) {
var anchor_id = document.location.hash.substr(1); //strip #
var element = $('#' + anchor_id);
// do we have such element + is it a modal? --> show it
if (element.length && element.hasClass('modal')) {
element.modal('show');
}
});
// execute hashchange on first page load
$(window).trigger('hashchange');
// remove url fragment on modal hide
$('.modal').on('hidden.bs.modal', function() {
try {
if (history && history.replaceState) {
history.replaceState({}, '', '#');
}
} catch(e) {}
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.badge_patch {
background-color: #ccc444;
}
.list-group,
.panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h1 {
font-size: 1.3em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
padding-right: 5px;
overflow: auto;
height: 90%;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
margin: 0;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
pre code {
overflow: auto;
word-wrap: normal;
white-space: pre;
}
.items {
background: #f5f5f5;
color: #333;
border: 1px solid #ccc;
border-radius: 4px;
padding: 9.5px;
margin: 0 0 10px;
font-size: 13px;
line-height: 1.42857143;
}
.examples {
margin-left: 0.5em;
}
.resource-modal li > ul {
margin-bottom: 1em;
}
.required {
color: #f00;
}
</style>
<link rel="icon" href="https://developers.meethue.com/wp-content/uploads/2018/11/cropped-PhilipsHueFREESTANDING-32x32.jpg" sizes="32x32">
<link rel="icon" href="https://developers.meethue.com/wp-content/uploads/2018/11/cropped-PhilipsHueFREESTANDING-192x192.jpg" sizes="192x192">
<link rel="apple-touch-icon" href="https://developers.meethue.com/wp-content/uploads/2018/11/cropped-PhilipsHueFREESTANDING-180x180.jpg">
<meta name="msapplication-TileImage" content="https://developers.meethue.com/wp-content/uploads/2018/11/cropped-PhilipsHueFREESTANDING-270x270.jpg">
</head><body data-spy="scroll" data-target="#sidebar" class="modal-open">
<div class="container">
<div class="row">
<div class="col-md-9" role="main">
<div class="page-header">
<h1>Hue CLIP API <small>version v2</small></h1>
<p>https://{bridge}/clip/v2</p>
<ul>
<li><strong>bridge</strong>: <em><span class="required">required</span>(string)</em>
<p>The ip address or hostname of the bridge</p>
</li>
</ul>
</div>
<div class="panel panel-default">
<div class="panel-heading">
<h3 id="resource" class="panel-title">/resource</h3>
</div>
<div class="panel-body">
<div class="top-resource-description">
<p>API to retrieve all API resources</p>
</div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading">
<h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#panel_resource"><span class="parent"></span>/resource</a> <span class="methods"><a href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_get"><span class="badge badge_get">get </span></a></span></h4>
</div>
<div id="panel_resource" class="panel-collapse collapse">
<div class="panel-body">
<div class="list-group">
<div onclick="window.location.href = '#resource_get'" class="list-group-item"><span class="badge badge_get">get </span><p></p>
<div class="method_description">
<p>List all resources of this type</p>
</div>
<div class="clearfix"></div>
</div>
</div>
</div>
</div>
<div class="modal fade in" tabindex="0" id="resource_get" style="display: block; padding-left: 0px;">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><p></p>
<h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get </span> <span class="parent"></span>/resource</h4>
</div>
<div class="modal-body">
<div class="alert alert-info">
<p>List all resources of this type</p>
</div>
<div class="alert alert-warning"> Secured by <b>hue-application-key</b><p></p>
<p>API authorization using a hue-application-key header</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_get_response" data-toggle="tab">Response</a></li>
<li><a href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="resource_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank" rel="noopener">200</a></h2>
<p>Request was on resource path was successful. Result of request is in data.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
<li><strong>data</strong>: <em><span class="required">required</span>(array of AnyResourceGet)</em></li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank" rel="noopener">401</a></h2>
<p>Client is not authorized</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank" rel="noopener">403</a></h2>
<p>Client is not allowed to perform operation on this resource.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank" rel="noopener">404</a></h2>
<p>Resource or resource path does not exist</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/405" target="_blank" rel="noopener">405</a></h2>
<p>Method is not supported by the resource</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/406" target="_blank" rel="noopener">406</a></h2>
<p>Query parameter has invalid value.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/409" target="_blank" rel="noopener">409</a></h2>
<p>Request conflict with the current state of the target resource</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/429" target="_blank" rel="noopener">429</a></h2>
<p>Too many requests</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank" rel="noopener">500</a></h2>
<p>Internal Server Error</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/503" target="_blank" rel="noopener">503</a></h2>
<p>Busy, try again later.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/507" target="_blank" rel="noopener">507</a></h2>
<p>Insufficient resources</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="tab-pane" id="resource_get_securedby">
<h1>Secured by hue-application-key</h1>
<h3>Headers</h3>
<ul>
<li><strong>hue-application-key</strong>: <em><span class="required">required</span>(string)</em>
<p>API token</p>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading">
<h3 id="resource_light" class="panel-title">/resource/light</h3>
</div>
<div class="panel-body">
<div class="top-resource-description">
<p>API to manage light services. These are offered by devices with lighting capabilities.</p>
</div>
<div class="panel-group">
<div class="panel panel-white resource-modal">
<div class="panel-heading">
<h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#panel_resource_light"><span class="parent"></span>/resource/light</a> <span class="methods"><a href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light_get"><span class="badge badge_get">get </span></a></span></h4>
</div>
<div id="panel_resource_light" class="panel-collapse collapse">
<div class="panel-body">
<div class="list-group">
<div onclick="window.location.href = '#resource_light_get'" class="list-group-item"><span class="badge badge_get">get </span><p></p>
<div class="method_description">
<p>List all resources of this type</p>
</div>
<div class="clearfix"></div>
</div>
</div>
</div>
</div>
<div class="modal fade" tabindex="0" id="resource_light_get">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><p></p>
<h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get </span> <span class="parent"></span>/resource/light</h4>
</div>
<div class="modal-body">
<div class="alert alert-info">
<p>List all resources of this type</p>
</div>
<div class="alert alert-warning"> Secured by <b>hue-application-key</b><p></p>
<p>API authorization using a hue-application-key header</p>
</div>
<ul class="nav nav-tabs">
<li class="active"><a href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light_get_response" data-toggle="tab">Response</a></li>
<li><a href="https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light_get_securedby" data-toggle="tab">Security</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="resource_light_get_response">
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank" rel="noopener">200</a></h2>
<p>Request was on resource path was successful. Result of request is in data.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
<li><strong>data</strong>: <em><span class="required">required</span>(array of LightGet)</em>
<p><strong>Items</strong>: LightGet</p>
<div class="items">
<ul>
<li><strong>id</strong>: <em><span class="required">required</span>(string – pattern: ^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$)</em>
<p>Unique identifier representing a specific resource instance</p>
</li>
<li><strong>id_v1</strong>: <em>(string – pattern: ^(\/[a-z]{4,32}\/[0-9a-zA-Z-]{1,32})?$)</em>
<p>Clip v1 resource identifier</p>
</li>
<li><strong>owner</strong>: <em><span class="required">required</span>(object)</em>
<p>Owner of the service, in case the owner service is deleted, the service also gets deleted</p>
<ul>
<li><strong>rid</strong>: <em><span class="required">required</span>(string – pattern: ^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$)</em>
<p>The unique id of the referenced resource</p>
</li>
<li><strong>rtype</strong>: <em><span class="required">required</span>(one of device, bridge_home, room, zone, service_group, light, button, bell_button, relative_rotary, temperature, light_level, motion, camera_motion, entertainment, contact, tamper, convenience_area_motion, security_area_motion, speaker, grouped_light, grouped_motion, grouped_light_level, device_power, device_software_update, zigbee_connectivity, zgp_connectivity, bridge, motion_area_candidate, wifi_connectivity, zigbee_device_discovery, homekit, matter, matter_fabric, scene, entertainment_configuration, public_image, auth_v1, behavior_script, behavior_instance, geofence_client, geolocation, smart_scene, motion_area_configuration, clip)</em>
<p>The type of the referenced resource</p>
</li>
</ul>
</li>
<li><strong>type</strong>: <em><span class="required">required</span>(light)</em></li>
<li><strong>metadata</strong>: <em><span class="required">required</span>(object)</em>
<p>additional metadata including a user given name</p>
<ul>
<li><strong>name</strong>: <em><span class="required">required</span>(string – minLength: 1 – maxLength: 32)</em>
<p>Human readable name of a resource</p>
</li>
<li><strong>archetype</strong>: <em><span class="required">required</span>(one of unknown_archetype, classic_bulb, sultan_bulb, flood_bulb, spot_bulb, candle_bulb, luster_bulb, pendant_round, pendant_long, ceiling_round, ceiling_square, floor_shade, floor_lantern, table_shade, recessed_ceiling, recessed_floor, single_spot, double_spot, table_wash, wall_lantern, wall_shade, flexible_lamp, ground_spot, wall_spot, plug, hue_go, hue_lightstrip, hue_iris, hue_bloom, bollard, wall_washer, hue_play, vintage_bulb, vintage_candle_bulb, ellipse_bulb, triangle_bulb, small_globe_bulb, large_globe_bulb, edison_bulb, christmas_tree, string_light, hue_centris, hue_lightstrip_tv, hue_lightstrip_pc, hue_tube, hue_signe, pendant_spot, ceiling_horizontal, ceiling_tube, up_and_down, up_and_down_up, up_and_down_down, hue_floodlight_camera, twilight, twilight_front, twilight_back, hue_play_wallwasher, hue_omniglow, hue_neon, string_globe, string_permanent)</em>
<p>Deprecated: use metadata on device level</p>
</li>
<li><strong>fixed_mired</strong>: <em>(integer – minimum: 50 – maximum: 1000)</em>
<p>A fixed mired value of the white lamp</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">233</code></pre>
</div>
</li>
<li><strong>function</strong>: <em><span class="required">required</span>(one of functional, decorative, mixed, unknown)</em>
<p>Function of the lightservice</p>
</li>
</ul>
</li>
<li><strong>product_data</strong>: <em>(object)</em>
<p>Factory defaults of the product data</p>
<ul>
<li><strong>name</strong>: <em>(string – minLength: 1 – maxLength: 32)</em>
<p>Name of the lightservice, only available for devices with multiple lightservices</p>
</li>
<li><strong>archetype</strong>: <em>(one of unknown_archetype, classic_bulb, sultan_bulb, flood_bulb, spot_bulb, candle_bulb, luster_bulb, pendant_round, pendant_long, ceiling_round, ceiling_square, floor_shade, floor_lantern, table_shade, recessed_ceiling, recessed_floor, single_spot, double_spot, table_wash, wall_lantern, wall_shade, flexible_lamp, ground_spot, wall_spot, plug, hue_go, hue_lightstrip, hue_iris, hue_bloom, bollard, wall_washer, hue_play, vintage_bulb, vintage_candle_bulb, ellipse_bulb, triangle_bulb, small_globe_bulb, large_globe_bulb, edison_bulb, christmas_tree, string_light, hue_centris, hue_lightstrip_tv, hue_lightstrip_pc, hue_tube, hue_signe, pendant_spot, ceiling_horizontal, ceiling_tube, up_and_down, up_and_down_up, up_and_down_down, hue_floodlight_camera, twilight, twilight_front, twilight_back, hue_play_wallwasher, hue_omniglow, hue_neon, string_globe, string_permanent)</em>
<p>Archetype of the lightservice, only available for devices with multiple lightservices</p>
</li>
<li><strong>function</strong>: <em><span class="required">required</span>(one of functional, decorative, mixed, unknown)</em>
<p>Function of the lightservice</p>
</li>
</ul>
</li>
<li><strong>identify</strong>: <em><span class="required">required</span>(object)</em>
<ul></ul>
</li>
<li><strong>service_id</strong>: <em><span class="required">required</span>(integer – minimum: 0)</em>
<p>Service identification number. 0 indicates service of a single instance</p>
</li>
<li><strong>on</strong>: <em><span class="required">required</span>(object)</em>
<ul>
<li><strong>on</strong>: <em><span class="required">required</span>(boolean)</em>
<p>On/Off state of the light on=true, off=false</p>
</li>
</ul>
</li>
<li><strong>dimming</strong>: <em>(object)</em>
<ul>
<li><strong>brightness</strong>: <em><span class="required">required</span>(number – maximum: 100)</em>
<p>Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">80</code></pre>
</div>
</li>
<li><strong>min_dim_level</strong>: <em>(number – minimum: 0 – maximum: 100)</em>
<p>Percentage of the maximum lumen the device outputs on minimum brightness</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"brightness"</span>: <span class="hljs-number">80</span>
}</code></pre>
</div>
</li>
<li><strong>dimming_delta</strong>: <em>(object)</em>
<ul></ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"action"</span>: <span class="hljs-string">"up"</span>,
<span class="hljs-attr">"brightness_delta"</span>: <span class="hljs-number">10.5</span>
}</code></pre>
</div>
</li>
<li><strong>color_temperature</strong>: <em>(object)</em>
<ul>
<li><strong>mirek</strong>: <em><span class="required">required</span>(integer – minimum: 50 – maximum: 1000)</em>
<p>color temperature in mirek or null when the light color is not in the ct spectrum</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">233</code></pre>
</div>
</li>
<li><strong>mirek_valid</strong>: <em><span class="required">required</span>(boolean)</em>
<p>Indication whether the value presented in mirek is valid</p>
</li>
<li><strong>mirek_schema</strong>: <em><span class="required">required</span>(object)</em>
<ul>
<li><strong>mirek_minimum</strong>: <em><span class="required">required</span>(integer – minimum: 50 – maximum: 1000)</em>
<p>minimum color temperature this light supports</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">233</code></pre>
</div>
</li>
<li><strong>mirek_maximum</strong>: <em><span class="required">required</span>(integer – minimum: 50 – maximum: 1000)</em>
<p>maximum color temperature this light supports</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">233</code></pre>
</div>
</li>
</ul>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"mirek_schema"</span>: {
<span class="hljs-attr">"mirek_minimum"</span>: <span class="hljs-number">153</span>,
<span class="hljs-attr">"mirek_maximum"</span>: <span class="hljs-number">500</span>
},
<span class="hljs-attr">"mirek"</span>: <span class="hljs-number">202</span>,
<span class="hljs-attr">"mirek_valid"</span>: <span class="hljs-literal">true</span>
}</code></pre>
</div>
</li>
<li><strong>color_temperature_delta</strong>: <em>(object)</em>
<ul></ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"action"</span>: <span class="hljs-string">"up"</span>,
<span class="hljs-attr">"mirek_delta"</span>: <span class="hljs-number">200</span>
}</code></pre>
</div>
</li>
<li><strong>color</strong>: <em>(object)</em>
<ul>
<li><strong>xy</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
<li><strong>gamut</strong>: <em>(object)</em>
<p>Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present.</p>
<ul>
<li><strong>red</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
<li><strong>green</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
<li><strong>blue</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
</ul>
</li>
<li><strong>gamut_type</strong>: <em><span class="required">required</span>(one of A, B, C, other)</em>
<p>The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"xy"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.6915</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.3083</span>
},
<span class="hljs-attr">"gamut_type"</span>: <span class="hljs-string">"C"</span>,
<span class="hljs-attr">"gamut"</span>: {
<span class="hljs-attr">"red"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.6915</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.3083</span>
},
<span class="hljs-attr">"green"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.17</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.7</span>
},
<span class="hljs-attr">"blue"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.1532</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.0475</span>
}
}
}</code></pre>
</div>
</li>
<li><strong>dynamics</strong>: <em>(object)</em>
<ul>
<li><strong>status</strong>: <em><span class="required">required</span>(one of dynamic_palette, none)</em>
<p>Current status of the lamp with dynamics.</p>
</li>
<li><strong>status_values</strong>: <em><span class="required">required</span>(array of SupportedDynamicStatus)</em>
<p>Statuses in which a lamp could be when playing dynamics.</p>
</li>
<li><strong>speed</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>speed of dynamic palette. The speed is only valid if the status is dynamic_palette.</p>
</li>
<li><strong>speed_valid</strong>: <em><span class="required">required</span>(boolean)</em>
<p>Indicates whether the value presented in speed is valid</p>
</li>
</ul>
</li>
<li><strong>alert</strong>: <em>(object)</em>
<ul>
<li><strong>action_values</strong>: <em><span class="required">required</span>(array of AlertEffectType)</em>
<p>Alert effects that the light supports.</p>
</li>
</ul>
</li>
<li><strong>signaling</strong>: <em>(object)</em>
<p>Feature containing signaling properties.</p>
<ul>
<li><strong>signal_values</strong>: <em><span class="required">required</span>(array of SupportedSignals)</em>
<p>Signals that the light supports.</p>
</li>
<li><strong>status</strong>: <em>(object)</em>
<p>Indicates status of active signal. Not available when inactive.</p>
<ul>
<li><strong>signal</strong>: <em><span class="required">required</span>(one of no_signal, on_off, on_off_color, alternating)</em>
<p>Indicates which signal is currently active.</p>
</li>
<li><strong>estimated_end</strong>: <em><span class="required">required</span>(datetime)</em>
<p>Timestamp indicating when the active signal is expected to end. Value is not set if there is no_signal</p>
</li>
<li><strong>colors</strong>: <em><span class="required">required</span>(array of ColorFeatureBasicGet)</em>
<p>Colors that were provided for the active effect.</p>
<p><strong>Items</strong>: ColorFeatureBasicGet</p>
<div class="items">
<ul>
<li><strong>xy</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"xy"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.6915</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.3083</span>
}
}</code></pre>
</div>
</div>
</li>
</ul>
</li>
</ul>
</li>
<li><strong>mode</strong>: <em><span class="required">required</span>(one of normal, streaming)</em>
<p>Mode the light is currently in</p>
</li>
<li><strong>gradient</strong>: <em>(object)</em>
<p>Basic feature containing gradient properties.</p>
<ul>
<li><strong>points</strong>: <em><span class="required">required</span>(array of GradientPointGet – maxItems: 5)</em>
<p>Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.</p>
<p><strong>Items</strong>: GradientPointGet</p>
<div class="items">
<ul>
<li><strong>color</strong>: <em><span class="required">required</span>(object)</em>
<ul>
<li><strong>xy</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"xy"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.6915</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.3083</span>
}
}</code></pre>
</div>
</li>
</ul>
</div>
</li>
<li><strong>mode</strong>: <em><span class="required">required</span>(one of interpolated_palette, interpolated_palette_mirrored, random_pixelated, segmented_palette)</em>
<p>Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette</p>
</li>
<li><strong>points_capable</strong>: <em><span class="required">required</span>(integer)</em>
<p>Number of color points that gradient lamp is capable of showing with gradience.</p>
</li>
<li><strong>mode_values</strong>: <em><span class="required">required</span>(array of SupportedGradientModes)</em>
<p>Modes a gradient device can deploy the gradient palette of colors</p>
</li>
<li><strong>pixel_count</strong>: <em>(integer)</em>
<p>Number of pixels in the device</p>
</li>
</ul>
</li>
<li><strong>effects</strong>: <em>(object)</em>
<p>Deprecated: use effects_v2</p>
<ul>
<li><strong>status_values</strong>: <em><span class="required">required</span>(array of SupportedEffects)</em>
<p>Possible status values in which a light could be when playing an effect.</p>
</li>
<li><strong>status</strong>: <em><span class="required">required</span>(one of prism, opal, glisten, sparkle, fire, candle, underwater, cosmos, sunbeam, enchant, no_effect)</em>
<p>Current status values the light is in regarding effects</p>
</li>
<li><strong>effect_values</strong>: <em><span class="required">required</span>(array of SupportedEffects)</em>
<p>Possible effect values you can set in a light.</p>
</li>
</ul>
</li>
<li><strong>effects_v2</strong>: <em>(object)</em>
<ul>
<li><strong>action</strong>: <em><span class="required">required</span>(object)</em>
<ul>
<li><strong>effect_values</strong>: <em><span class="required">required</span>(array of SupportedEffects)</em>
<p>Possible effect values you can set in a light.</p>
</li>
</ul>
</li>
<li><strong>status</strong>: <em><span class="required">required</span>(object)</em>
<ul>
<li><strong>effect</strong>: <em><span class="required">required</span>(one of prism, opal, glisten, sparkle, fire, candle, underwater, cosmos, sunbeam, enchant, no_effect)</em></li>
<li><strong>effect_values</strong>: <em><span class="required">required</span>(array of SupportedEffects)</em></li>
<li><strong>parameters</strong>: <em>(object)</em>
<ul>
<li><strong>color</strong>: <em>(object)</em>
<ul>
<li><strong>xy</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"xy"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.6915</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.3083</span>
}
}</code></pre>
</div>
</li>
<li><strong>color_temperature</strong>: <em>(object)</em>
<ul>
<li><strong>mirek</strong>: <em><span class="required">required</span>(integer – minimum: 50 – maximum: 1000)</em>
<p>color temperature in mirek or null when the light color is not in the ct spectrum</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">233</code></pre>
</div>
</li>
<li><strong>mirek_valid</strong>: <em><span class="required">required</span>(boolean)</em>
<p>Indication whether the value presented in mirek is valid</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"mirek"</span>: <span class="hljs-number">202</span>,
<span class="hljs-attr">"mirek_valid"</span>: <span class="hljs-literal">true</span>
}</code></pre>
</div>
</li>
<li><strong>speed</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li><strong>timed_effects</strong>: <em>(object)</em>
<ul>
<li><strong>status_values</strong>: <em><span class="required">required</span>(array of SupportedTimedEffects)</em>
<p>Possible status values in which a light could be when playing a timed effect.</p>
</li>
<li><strong>status</strong>: <em><span class="required">required</span>(one of sunrise, sunset, no_effect)</em>
<p>Current status values the light is in regarding timed effects</p>
</li>
<li><strong>effect_values</strong>: <em><span class="required">required</span>(array of SupportedTimedEffects)</em>
<p>Possible timed effect values you can set in a light.</p>
</li>
</ul>
</li>
<li><strong>powerup</strong>: <em>(object)</em>
<p>Feature containing properties to configure powerup behaviour of a lightsource.</p>
<ul>
<li><strong>preset</strong>: <em><span class="required">required</span>(one of safety, powerfail, last_on_state, custom)</em>
<p>When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.</p>
</li>
<li><strong>configured</strong>: <em><span class="required">required</span>(boolean)</em>
<p>Indicates if the shown values have been configured in the lightsource.</p>
</li>
<li><strong>on</strong>: <em><span class="required">required</span>(object)</em>
<ul>
<li><strong>mode</strong>: <em><span class="required">required</span>(one of on, toggle, previous)</em>
<p>State to activate after powerup. On will use the value specified in the “on” property. When setting mode “on”, the on property must be included. Toggle will alternate between on and off on each subsequent power toggle. Previous will return to the state it was in before powering off.</p>
</li>
<li><strong>on</strong>: <em>(object)</em>
<ul>
<li><strong>on</strong>: <em><span class="required">required</span>(boolean)</em>
<p>On/Off state of the light on=true, off=false</p>
</li>
</ul>
</li>
</ul>
</li>
<li><strong>dimming</strong>: <em>(object)</em>
<ul>
<li><strong>mode</strong>: <em><span class="required">required</span>(one of dimming, previous)</em>
<p>Dimming will set the brightness to the specified value after power up. When setting mode “dimming”, the dimming property must be included. Previous will set brightness to the state it was in before powering off.</p>
</li>
<li><strong>dimming</strong>: <em>(object)</em>
<ul>
<li><strong>brightness</strong>: <em><span class="required">required</span>(number – maximum: 100)</em>
<p>Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">80</code></pre>
</div>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"brightness"</span>: <span class="hljs-number">80</span>
}</code></pre>
</div>
</li>
</ul>
</li>
<li><strong>color</strong>: <em>(object)</em>
<ul>
<li><strong>mode</strong>: <em><span class="required">required</span>(one of color_temperature, color, previous)</em>
<p>State to activate after powerup. Availability of “color_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color_temperature, the color_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off.</p>
</li>
<li><strong>color_temperature</strong>: <em>(object)</em>
<ul>
<li><strong>mirek</strong>: <em><span class="required">required</span>(integer – minimum: 50 – maximum: 1000)</em>
<p>color temperature in mirek or null when the light color is not in the ct spectrum</p>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs">233</code></pre>
</div>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"mirek"</span>: <span class="hljs-number">202</span>
}</code></pre>
</div>
</li>
<li><strong>color</strong>: <em>(object)</em>
<ul>
<li><strong>xy</strong>: <em><span class="required">required</span>(object)</em>
<p>CIE XY gamut position</p>
<ul>
<li><strong>x</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>X position in color gamut</p>
</li>
<li><strong>y</strong>: <em><span class="required">required</span>(number – minimum: 0 – maximum: 1)</em>
<p>Y position in color gamut</p>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.369</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.445</span>
}</code></pre>
</div>
</li>
</ul>
<p><strong>Example</strong>:</p>
<div class="examples">
<pre><code class="hljs json">{
<span class="hljs-attr">"xy"</span>: {
<span class="hljs-attr">"x"</span>: <span class="hljs-number">0.6915</span>,
<span class="hljs-attr">"y"</span>: <span class="hljs-number">0.3083</span>
}
}</code></pre>
</div>
</li>
</ul>
</li>
</ul>
</li>
<li><strong>content_configuration</strong>: <em>(object)</em>
<p>Configuration parameters that affect how content is deployed on a product</p>
<ul>
<li><strong>orientation</strong>: <em>(object)</em>
<p>Orientation for content deployed on pixelated products when applicable (e.g. sunrise, candle)</p>
<ul>
<li><strong>status</strong>: <em><span class="required">required</span>(one of set, changing)</em></li>
<li><strong>configurable</strong>: <em><span class="required">required</span>(boolean)</em>
<p>Indicates if the product allows modifying the configuration attribute</p>
</li>
<li><strong>orientation</strong>: <em><span class="required">required</span>(one of horizontal, vertical)</em></li>
</ul>
</li>
<li><strong>order</strong>: <em>(object)</em>
<p>Order in which the content is represented on the pixels</p>
<ul>
<li><strong>status</strong>: <em><span class="required">required</span>(one of set, changing)</em></li>
<li><strong>configurable</strong>: <em><span class="required">required</span>(boolean)</em>
<p>Indicates if the product allows modifying the configuration attribute</p>
</li>
<li><strong>order</strong>: <em><span class="required">required</span>(one of forward, reversed)</em></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank" rel="noopener">401</a></h2>
<p>Client is not authorized</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank" rel="noopener">403</a></h2>
<p>Client is not allowed to perform operation on this resource.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank" rel="noopener">404</a></h2>
<p>Resource or resource path does not exist</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/405" target="_blank" rel="noopener">405</a></h2>
<p>Method is not supported by the resource</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/406" target="_blank" rel="noopener">406</a></h2>
<p>Query parameter has invalid value.</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class="required">required</span>(array of Error)</em>
<p><strong>Items</strong>: Error</p>
<div class="items">
<ul>
<li><strong>description</strong>: <em><span class="required">required</span>(string)</em>
<p>a human-readable explanation specific to this occurrence of the problem.</p>
</li>
</ul>
</div>
</li>
</ul>
<h2>HTTP status code <a href="http://httpstatus.es/409" target="_blank" rel="noopener">409</a></h2>
<p>Request conflict with the current state of the target resource</p>
<h3>Body</h3>
<p><strong>Media type</strong>: application/json</p>
<p><strong>Type</strong>: object</p>
<p><strong>Properties</strong></p>
<ul>
<li><strong>errors</strong>: <em><span class=