MotionAreaCandidate

API to manage motion area candidates.

List motion area candidates.

get

List all available motion area candidates resources.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Responses

200

MotionAreaCandidate Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/motion_area_candidate

HTTPcURLJavaScriptPython

GET /clip/v2/resource/motion_area_candidate HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "motion_sensors": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ]
    }
  ]
}

Get motion area candidate.

get

Get details of a single motion area candidate resource from its given {motionAreaCandidateId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

motionAreaCandidateIdstringRequired

ID of the motion area candidate

Responses

200

MotionAreaCandidate Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/motion_area_candidate/{motionAreaCandidateId}

HTTPcURLJavaScriptPython

GET /clip/v2/resource/motion_area_candidate/{motionAreaCandidateId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "motion_sensors": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ]
    }
  ]
}

Update motion area candidate.

put

Update a single motion area candidate resource from its given {motionAreaCandidateId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

motionAreaCandidateIdstringRequired

ID of the motion area candidate

Body

application/json

typestringOptional

Type of the supported resources (always motion_area_candidate here)

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

put/clip/v2/resource/motion_area_candidate/{motionAreaCandidateId}

HTTPcURLJavaScriptPython

PUT /clip/v2/resource/motion_area_candidate/{motionAreaCandidateId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "type": "text"
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}