### Get All Setup Triggers API Request

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

This is an example of a GET request to retrieve all setup triggers. The endpoint is '/triggers'.

```http
GET

Setup Triggers

/triggers

application/json

Get all setup triggers  
  
  

Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)

> [Test operation](doc/test/800c27c076f4ef451ded9c5e8f9d98ed61acf9c4d12379231ee9e7825a923435)

Response

Type

Name

Value

Description

Response Body

(JSON)

_[
  {
  "ifThenSetupTrigger" : {
    "creationTime" : 1612274610177,
    "lastUpdateTime" : 1612274610183,
    "label" : "an if then setup trigger label",
    "serverSide" : true,
    "mode" : 1,
    "schedulingIntervals" : [ {
      "weeklySchedule" : {
        "startMinutes" : 1,
        "startDay" : 2,
        "stopMinutes" : 1,
        "stopDay" : 6
      }
    } ],
    "allowExecuteOnEnabled" : false,
    "id" : "an id",
    "metadata" : "some metadata",
    "rootConditionBlock" : {
      "orBlock" : {
        "blockId" : "a block id",
        "activationDelay" : 1,
        "subConditionBlocks" : [ {
          "staticDeviceStateCondition" : {
            "blockId" : "a block id",
            "activationDelay" : 1,
            "stateName" : "a state name",
            "operator" : "BETWEEN_EXCLUSIVE",
            "value1" : "a value1",
            "value2" : "a value2",
            "objectPath" : "an object path",
            "type" : "EVENT_BASED",
            "deviceURL" : "<protocol>://<gatewayId>/<deviceAddress>"
          }
        } ]
      }
    },
    "effects" : [ {
      "actionGroupEffect" : {
        "id" : "an id",
        "actionGroupOID" : "an action group OID",
        "localActionGroup" : {
          "creationTime" : 1612274610182,
          "lastUpdateTime" : 1612274610182,
          "label" : "a managed action group label",
          "metadata" : "some metadata",
          "shortcut" : true,
          "notificationTypeMask" : 1,
          "notificationCondition" : "ON_SUCCESS",
          "notificationText" : "a notification text",
          "notificationTitle" : "a notification title",
          "targetEmailAddresses" : [ "some target email addresses" ],
          "targetPhoneNumbers" : [ "some target phone numbers" ],
          "targetPushSubscriptions" : [ "some target push subscriptions" ],
          "actions" : [ {
            "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
            "commands" : [ {
              "type" : 1,
              "name" : "a command name",
              "parameters" : [ "some parameters" ],
              "sensitiveParametersIndexes" : [ 1 ],
              "authentication" : "an authentication",
              "delay" : 1
            } ]
          } ],
          "oid" : "the managed action group UUID"
        }
      }
    } ],
    "usingTriggerModeFlag" : false,
    "oid" : "the if then setup trigger UUID"
  }
}
]_
```

--------------------------------

### Get All Devices

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieve the setup definition for all devices associated with the setup.

```APIDOC
## GET /setup/devices

### Description
Get setup definition.

### Method
GET

### Endpoint
/setup/devices

### Response
#### Success Response (200 OK)
- **creationTime** (integer) - The creation timestamp of the device.
- **lastUpdateTime** (integer) - The last update timestamp of the device.
- **label** (string) - The user-defined label for the device.
- **deviceURL** (string) - The URL of the device.
- **shortcut** (boolean) - Indicates if the device is a shortcut.
- **controllableName** (string) - The controllable name of the device.
- **metadata** (string) - Metadata associated with the device.
- **definition** (object) - The definition of the device, including commands, states, and data properties.
- **states** (array) - An array of the current states of the device.
- **attributes** (array) - An array of attributes associated with the device.
- **available** (boolean) - Indicates if the device is available.
- **enabled** (boolean) - Indicates if the device is enabled.
- **placeOID** (string) - The OID of the place the device belongs to.
- **widget** (string) - The widget name associated with the device.
- **type** (integer) - The type of the device.
- **oid** (string) - The unique OID (UUID) of the device.
- **uiClass** (string) - The UI class of the device.

### Response Example
```json
[
  {
    "creationTime": 1612274610344,
    "lastUpdateTime": 1612274610345,
    "label": "a device label",
    "deviceURL": "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
    "shortcut": false,
    "controllableName": "core:StatefulClosableActuator",
    "metadata": "some metadata",
    "definition": {
      "commands": [
        {
          "commandName": "a command name",
          "nparams": 0
        }
      ],
      "states": [
        {
          "type": "ContinuousState"
        }
      ],
      "dataProperties": [
        {
          "value": "a data property value"
        }
      ],
      "widgetName": "a widget name",
      "uiClass": "a ui class",
      "uiClassifiers": [
        "some ui classifiers"
      ],
      "type": "ACTUATOR"
    },
    "states": [
      {
        "name": "a device state name",
        "type": 1,
        "value": "a device state value",
        "lastUpdateTime": 120123456795
      }
    ],
    "attributes": [
      {
        "name": "a device attribute name",
        "type": 1,
        "value": "a device attribute value"
      }
    ],
    "available": true,
    "enabled": true,
    "placeOID": "a place OID",
    "widget": "a widget name",
    "type": 1,
    "oid": "the device UUID",
    "uiClass": "a ui class"
  }
]
```
```

--------------------------------

### Get setup label

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves the setup label for the end-user.

```APIDOC
## GET /enduser/setupLabel

### Description
Get setup label.

### Method
GET

### Endpoint
/enduser/setupLabel

### Response
#### Success Response (200)
- **result** (string) - The setup label.
```

--------------------------------

### Get Setup Files

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves a list of all uploaded files associated with a setup.

```APIDOC
## GET /setup/files

### Description
Get the list of uploaded files on the setup.

### Method
GET

### Endpoint
/setup/files

### Response
#### Success Response (200)
- **filename** (string) - The name of the file.
- **size** (integer) - The size of the file in bytes.
- **uploadTime** (integer) - The timestamp when the file was uploaded.
- **metadata** (string) - Metadata associated with the file.
- **comments** (string) - Comments related to the file.
- **oid** (string) - The unique identifier for the setup file.

#### Response Example
```json
[
  {
    "filename": "a filename",
    "size": 2,
    "uploadTime": 1612274610422,
    "metadata": "some metadata",
    "comments": "some comments",
    "oid": "the setup file UUID"
  }
]
```
```

--------------------------------

### Get Setup Places

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves a list of all places configured in the user's setup, starting from the root.

```APIDOC
## GET /setup/places

### Description
Retrieves setup places starting from the root.

### Method
GET

### Endpoint
/setup/places

### Response
#### Success Response (200)
- **creationTime** (integer) - The creation timestamp of the place.
- **lastUpdateTime** (integer) - The last update timestamp of the place.
- **label** (string) - The label or name of the place.
- **type** (integer) - The type identifier for the place.
- **metadata** (string) - Additional metadata associated with the place.
- **oid** (string) - The unique object identifier for the place.
- **subPlaces** (array) - An array of sub-places within this place.

#### Response Example
```json
{
  "creationTime" : 1612274610367,
  "lastUpdateTime" : 1612274610367,
  "label" : "a place label",
  "type" : 1,
  "metadata" : "some metadata",
  "oid" : "the place UUID",
  "subPlaces" : [
    {
      "creationTime" : 1612274610367,
      "lastUpdateTime" : 1612274610367,
      "label" : "a place label",
      "type" : 1,
      "metadata" : "some metadata",
      "oid" : "the place UUID",
      "subPlaces" : [
        {
          "creationTime" : 1612274610367,
          "lastUpdateTime" : 1612274610367,
          "label" : "a place label",
          "type" : 1,
          "metadata" : "some metadata",
          "oid" : "the place UUID",
          "subPlaces" : []
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Get Setup Additional Information

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves additional information for a setup.

```APIDOC
## GET /setup/additionalInformation

### Description
Get additional information.
This operation returns setup additional information.

Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)

### Method
GET

### Endpoint
/setup/additionalInformation

### Response
#### Success Response (200)
- **templateId** (string) - The ID of the template for the additional information.
- **type** (string) - The type of the additional information (e.g., "SERIAL_NUMBER").
- **label** (string) - A label for the additional information.
- **value** (string) - The value of the additional information.
- **rank** (integer) - The rank or order of the information.
- **unsafe** (boolean) - Indicates if the information is considered unsafe.

#### Response Example
```json
[
  {
    "templateId": "a template id",
    "type": "SERIAL_NUMBER",
    "label": "a setup additional info label",
    "value": "a setup additional info value",
    "rank": 1,
    "unsafe": true
  }
]
```
```

--------------------------------

### Get All Setup Information

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves all setup information for the connected user. Activation and expiration timestamps are in milliseconds since EPOCH.

```http
GET /enduser/setups
```

--------------------------------

### Example Setup Creation Options

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

This JSON structure represents options for creating a new setup, including tariff modes and schedule details.

```json
{
      "tariffMode" : "offPeakWeekDays",
      "tariffs" : [
        {
          "dayTariffs" : [
            {
              "name" : "tariff0",
              "startTime" : "00:00"
            }
          ],
          "dayWeekName" : "SAT"
        }
      ]
    }
```

--------------------------------

### Get Setup File Download URL

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves a URL for downloading a specific setup file.

```APIDOC
## GET /setup/files/{fileOID}/downloadURL

### Description
Get download url for setup file.

### Method
GET

### Endpoint
/setup/files/{fileOID}/downloadURL

### Parameters
#### Path Parameters
- **fileOID** (string) - Required - The Object ID (OID) of the file to download.

### Response
#### Success Response (200)
- **downloadURL** (string) - The URL to use for downloading the file.

#### Response Example
```json
{
  "downloadURL": "string value"
}
```
```

--------------------------------

### Get all setup information

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves all setup information for the connected user. Activation/Expiration timestamps are expressed as milliseconds since EPOCH.

```APIDOC
## GET /enduser/setups

### Description
Get all setup information for the connected user. Activation/Expiration timestamps are expressed as milliseconds since EPOCH.

### Method
GET

### Endpoint
/enduser/setups

### Response
#### Success Response (200)
- **setupOID** (string) - The setup OID.
- **userId** (string) - The user ID.
- **templateName** (string) - The template name.
- **owner** (boolean) - Indicates if the user is the owner.
- **defaultSetup** (boolean) - Indicates if this is the default setup.
- **label** (string) - The setup end user label.
- **activationTimestamp** (integer) - Activation timestamp in milliseconds since EPOCH.
- **expirationTimestamp** (integer) - Expiration timestamp in milliseconds since EPOCH.
```

--------------------------------

### Get Setup Quotas

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieve all remaining quotas values for a setup.

```APIDOC
## GET /setup/quotas

### Description
Get setup quotas. This operation returns remaining quotas value.

### Method
GET

### Endpoint
/setup/quotas

### Response
#### Success Response (200)
- **setupOID** (string) - a setup OID
- **descriptorId** (string) - a descriptor id
- **currentValue** (integer) - the current quota value
- **oid** (string) - the setup quota UUID

#### Response Example
```json
[
  {
    "setupOID" : "a setup OID",
    "descriptorId" : "a descriptor id",
    "currentValue" : 1,
    "oid" : "the setup quota UUID"
  }
]
```
```

--------------------------------

### Get Setup Triggers by Type API Request

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

This is an example of a GET request to retrieve setup triggers of a specific type. The endpoint is '/triggers/{type}'.

```http
GET

Setup Triggers by type

/triggers/{type}

application/json

Get all setup triggers of a given type  
  
  

> [Test operation](doc/test/32b6b3f220032b9efeb2e262d354a198010ccdc3f1021c27d069e367bd567e62)

Parameters

Type

Name

Value

Description

Path Variable

type

_"string value"_

Setup trigger type

Response

Type

Name

Value

Description

Response Body

(JSON)

_[
  {
  "ifThenSetupTrigger" : {
    "creationTime" : 1612274610177,
    "lastUpdateTime" : 1612274610183,
    "label" : "an if then setup trigger label",
    "serverSide" : true,
    "mode" : 1,
    "schedulingIntervals" : [ {

```

--------------------------------

### Get Setup Label

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves the setup label for the connected user. This endpoint is used for end-user setup.

```http
GET /enduser/setupLabel
```

--------------------------------

### Get Setup File Upload URL

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Obtains a URL for uploading a new file to the setup.

```APIDOC
## GET /setup/files/uploadURL

### Description
Get upload url for setup file.

### Method
GET

### Endpoint
/setup/files/uploadURL

### Parameters
#### Query Parameters
- **fileType** (string) - Required - The type of the file to be uploaded.
- **fileName** (string) - Optional - The name of the file.

### Response
#### Success Response (200)
- **uploadURL** (string) - The URL to use for uploading the file.

#### Response Example
```json
{
  "uploadURL": "string value"
}
```
```

--------------------------------

### Get Setup Features

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieve all setup features of a setup. This endpoint is rate-limited to 1 call per day.

```APIDOC
## GET /setup/features

### Description
Get setup features. Retrieve all setup features of a setup.

### Method
GET

### Endpoint
/setup/features

### Response
#### Success Response (200)
- **name** (string) - a setup feature name
- **source** (string) - a source

#### Response Example
```json
[
  {
    "name" : "a setup feature name",
    "source" : "a source"
  }
]
```
```

--------------------------------

### Get All Devices

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

GET request to retrieve the setup definition for all devices. This operation has a per-session rate-limit of 1 call per 1 day.

```http
GET

/setup/devices

application/json

Get setup definition
```

--------------------------------

### Get Setup Options

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieve all subscribed options of a given setup. This endpoint is rate-limited to 1 call per day.

```APIDOC
## GET /setup/options

### Description
Get setup options. This operation returns all subscribed options of a given setup.

### Method
GET

### Endpoint
/setup/options

### Response
#### Success Response (200)
- **creationTime** (integer) - creation timestamp
- **lastUpdateTime** (integer) - last update timestamp
- **optionId** (string) - an option id
- **startDate** (integer) - start date timestamp
- **endDate** (integer) - end date timestamp
- **parameters** (array) - array of option parameters
  - **name** (string) - a setup option parameter name
  - **value** (string) - a setup option parameter value

#### Response Example
```json
[
  {
    "creationTime" : 1612274610386,
    "lastUpdateTime" : 1612274610386,
    "optionId" : "an option id",
    "startDate" : 1612274610390,
    "endDate" : 1612274610386,
    "parameters" : [
      {
        "name" : "a setup option parameter name",
        "value" : "a setup option parameter value"
      }
    ]
  }
]
```
```

--------------------------------

### Get Setup Information

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves all data about the connected user setup, including gateways, location, places, and devices.

```APIDOC
## GET /setup

### Description
Retrieves all data about the connected user setup, including gateways data (serial number, activation state, ...), setup location, house places (rooms and floors), and setup devices. Data of one or several devices can also be retrieved by setting the device(s) URL as a request parameter.

### Method
GET

### Endpoint
/setup

### Query Parameters
- **gateways/gateway** (string) - Optional - Retrieves gateways data.
- **location** (string) - Optional - Retrieves setup location.
- **place** (string) - Optional - Retrieves house places (rooms and floors).
- **devices** (string) - Optional - Retrieves setup devices.

### Response
#### Success Response (200)
- **creationTime** (integer) - The creation time of the setup.
- **lastUpdateTime** (integer) - The last update time of the setup.
- **id** (string) - The unique identifier of the setup.
- **location** (object) - Details about the setup's location.
- **gateways** (array) - An array of gateway objects.
- **devices** (array) - An array of device objects.
- **zones** (array) - An array of zone objects.

### Response Example
```json
{
  "creationTime": 1612274610407,
  "lastUpdateTime": 1612274610411,
  "id": "an id",
  "location": {
    "creationTime": 1612274610411,
    "lastUpdateTime": 1612274610411,
    "city": "a city",
    "country": "a country",
    "postalCode": "a postal code",
    "addressLine1": "an address line1",
    "addressLine2": "an address line2",
    "timezone": "a timezone",
    "longitude": 0.12345,
    "latitude": 0.12345,
    "twilightMode": 1,
    "twilightAngle": "SOLAR",
    "twilightCity": "a twilight city",
    "summerSolsticeDuskMinutes": 1,
    "winterSolsticeDuskMinutes": 1,
    "twilightOffsetEnabled": true,
    "dawnOffset": 1,
    "duskOffset": 1,
    "tariffSettings": {
      "tariffMode": "offPeakWeekDays",
      "tariffs": [
        {
          "dayTariffs": [
            {
              "name": "tariff0",
              "startTime": "00:00"
            }
          ],
          "dayWeekName": "SAT"
        }
      ]
    }
  },
  "gateways": [
    {
      "gatewayId": "a gateway id",
      "type": 1,
      "subType": 1,
      "placeOID": "a place OID",
      "alive": true,
      "timeReliable": false,
      "connectivity": {
        "status": "NOT_SUPPORTED",
        "problems": ["NO_NTP"],
        "protocolVersion": "a protocol version"
      },
      "upToDate": true,
      "updateStatus": "READY_TO_BE_UPDATED_BY_SERVER",
      "syncInProgress": true,
      "updateCriticityLevel": "BLOCKING",
      "mode": "ACTIVE",
      "functions": "some function names"
    }
  ],
  "devices": [
    {
      "creationTime": 1612274610408,
      "lastUpdateTime": 1612274610408,
      "label": "a device label",
      "deviceURL": "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
      "shortcut": false,
      "controllableName": "core:StatefulClosableActuator",
      "metadata": "some metadata",
      "definition": {
        "commands": [
          {
            "commandName": "a command name",
            "nparams": 0
          }
        ],
        "states": [
          {
            "type": "ContinuousState"
          }
        ],
        "dataProperties": [
          {
            "value": "a data property value"
          }
        ],
        "widgetName": "a widget name",
        "uiClass": "a ui class",
        "uiClassifiers": ["some ui classifiers"],
        "type": "ACTUATOR"
      },
      "states": [
        {
          "name": "a device state name",
          "type": 1,
          "value": "a device state value",
          "lastUpdateTime": 120123456795
        }
      ],
      "attributes": [
        {
          "name": "a device attribute name",
          "type": 1,
          "value": "a device attribute value"
        }
      ],
      "available": true,
      "enabled": true,
      "placeOID": "a place OID",
      "widget": "a widget name",
      "type": 1,
      "oid": "the device UUID",
      "uiClass": "a ui class"
    }
  ],
  "zones": [
    {
      "creationTime": 1612274610411,
      "lastUpdateTime": 1612274610412,
      "label": "a zone label",
      "type": 0,
      "items": [
        {
          "itemType": "device",
          "deviceOID": "a device OID",
          "deviceURL": "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])"
        }
      ],
      "externalOID": "an external OID",
      "metadata": "some metadata",
      "oid": "the zone UUID"
    }
  ],
  "resellerDelegationType": "DATE",
  "resellerDelegationEndDate": 1612274610411
}
```
```

--------------------------------

### Get Setup Trigger API Endpoint

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Demonstrates the GET request to retrieve a setup trigger by its type and OID. This endpoint is used to fetch configuration details of a specific trigger.

```http
GET /triggers/{type}/{triggerOID} HTTP/1.1
Host: api.example.com
Accept: application/json
```

--------------------------------

### Get all setup triggers of a given type

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves a list of setup triggers filtered by a specific type.

```APIDOC
## GET /triggers/{type}

### Description
Get all setup triggers of a given type.

### Method
GET

### Endpoint
/triggers/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - Setup trigger type.

### Response
#### Success Response (200)
- **ifThenSetupTrigger** (object) - Details of the setup trigger.
  - **creationTime** (number) - Timestamp of trigger creation.
  - **lastUpdateTime** (number) - Timestamp of last trigger update.
  - **label** (string) - User-defined label for the trigger.
  - **serverSide** (boolean) - Indicates if the trigger is managed server-side.
  - **mode** (number) - Trigger mode.
  - **schedulingIntervals** (array) - Scheduling details for the trigger.
    - **weeklySchedule** (object) - Weekly scheduling configuration.
      - **startMinutes** (number) - Start minute of the schedule.
      - **startDay** (number) - Start day of the week.
      - **stopMinutes** (number) - Stop minute of the schedule.
      - **stopDay** (number) - Stop day of the week.

### Response Example
[
  {
    "ifThenSetupTrigger": {
      "creationTime": 1612274610177,
      "lastUpdateTime": 1612274610183,
      "label": "an if then setup trigger label",
      "serverSide": true,
      "mode": 1,
      "schedulingIntervals": [
        {
          "weeklySchedule": {
            "startMinutes": 1,
            "startDay": 2,
            "stopMinutes": 1,
            "stopDay": 6
          }
        }
      ]
    }
  }
]
```

--------------------------------

### Get Specific Setup Additional Information

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves specific additional information for a setup based on its template ID.

```APIDOC
## GET /setup/additionalInformation/{templateId}

### Description
Get additional information.
This operation returns setup additional information.

### Method
GET

### Endpoint
/setup/additionalInformation/{templateId}

### Parameters
#### Path Parameters
- **templateId** (string) - Required - The template ID of the additional information to retrieve.

### Response
#### Success Response (200)
- **templateId** (string) - The ID of the template for the additional information.
- **type** (string) - The type of the additional information (e.g., "SERIAL_NUMBER").
- **label** (string) - A label for the additional information.
- **value** (string) - The value of the additional information.
- **rank** (integer) - The rank or order of the information.
- **unsafe** (boolean) - Indicates if the information is considered unsafe.

#### Response Example
```json
{
  "templateId": "a template id",
  "type": "SERIAL_NUMBER",
  "label": "a setup additional info label",
  "value": "a setup additional info value",
  "rank": 1,
  "unsafe": true
}
```
```

--------------------------------

### Get Specific Setup Option Parameter

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieve a specific parameter of a subscribed option for a given setup.

```APIDOC
## GET /setup/options/{optionId}/{parameterName}

### Description
Get setup options. This operation returns all subscribed options of a given setup.

### Method
GET

### Endpoint
/setup/options/{optionId}/{parameterName}

### Parameters
#### Path Parameters
- **optionId** (string) - Required - The id of the option to retrieve
- **parameterName** (string) - Required - The name of the option parameter to retrieve

### Response
#### Success Response (200)
- **name** (string) - a setup option parameter name
- **value** (string) - a setup option parameter value

#### Response Example
```json
{
  "name" : "a setup option parameter name",
  "value" : "a setup option parameter value"
}
```
```

--------------------------------

### Get Specific Setup Quota

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieve a specific quota for a setup using its ID.

```APIDOC
## GET /setup/quotas/{quotaId}

### Description
Get setup quotas. This operation returns a quota.

### Method
GET

### Endpoint
/setup/quotas/{quotaId}

### Parameters
#### Path Parameters
- **quotaId** (string) - Required - Quota id

### Response
#### Success Response (200)
- **setupOID** (string) - a setup OID
- **descriptorId** (string) - a descriptor id
- **currentValue** (integer) - the current quota value
- **oid** (string) - the setup quota UUID

#### Response Example
```json
{
  "setupOID" : "a setup OID",
  "descriptorId" : "a descriptor id",
  "currentValue" : 1,
  "oid" : "the setup quota UUID"
}
```
```

--------------------------------

### Get Device Information

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves the definition of a specific setup device using its URL.

```APIDOC
## GET /setup/devices/{deviceURL}

### Description
Get a particular setup device definition.

### Method
GET

### Endpoint
/setup/devices/{deviceURL}

### Parameters
#### Path Parameters
- **deviceURL** (string) - Required - The url of the device

### Response
#### Success Response (200)
- **creationTime** (integer) - The time the device was created.
- **lastUpdateTime** (integer) - The time the device was last updated.
- **label** (string) - The label of the device.
- **deviceURL** (string) - The URL of the device.
- **shortcut** (boolean) - Indicates if the device is a shortcut.
- **controllableName** (string) - The controllable name of the device.
- **metadata** (string) - Metadata associated with the device.
- **definition** (object) - The definition of the device, including commands, states, and data properties.
- **states** (array) - An array of the current states of the device.
- **attributes** (array) - An array of attributes associated with the device.
- **available** (boolean) - Indicates if the device is available.
- **enabled** (boolean) - Indicates if the device is enabled.
- **placeOID** (string) - The OID of the place the device belongs to.
- **widget** (string) - The widget name associated with the device.
- **type** (integer) - The type of the device.
- **oid** (string) - The unique identifier (OID) of the device.
- **uiClass** (string) - The UI class of the device.

### Response Example
```json
{
  "creationTime" : 1612274610340,
  "lastUpdateTime" : 1612274610340,
  "label" : "a device label",
  "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
  "shortcut" : false,
  "controllableName" : "core:StatefulClosableActuator",
  "metadata" : "some metadata",
  "definition" : {
    "commands" : [
      {
        "commandName" : "a command name",
        "nparams" : 0
      }
    ],
    "states" : [
      {
        "type" : "ContinuousState"
      }
    ],
    "dataProperties" : [
      {
        "value" : "a data property value"
      }
    ],
    "widgetName" : "a widget name",
    "uiClass" : "a ui class",
    "uiClassifiers" : [
      "some ui classifiers"
    ],
    "type" : "ACTUATOR"
  },
  "states" : [
    {
      "name" : "a device state name",
      "type" : 1,
      "value" : "a device state value",
      "lastUpdateTime" : 120123456795
    }
  ],
  "attributes" : [
    {
      "name" : "a device attribute name",
      "type" : 1,
      "value" : "a device attribute value"
    }
  ],
  "available" : true,
  "enabled" : true,
  "placeOID" : "a place OID",
  "widget" : "a widget name",
  "type" : 1,
  "oid" : "the device UUID",
  "uiClass" : "a ui class"
}
```
```

--------------------------------

### GET /setup/calendar/rules

Source: https://github.com/imicknl/python-overkiz-api/blob/main/docs/tahoma_api.html

Retrieves all calendar rules for a given setup. This endpoint is subject to a per-session rate limit of 1 call per 1-day period.

```APIDOC
## GET /setup/calendar/rules

### Description
Get all calendar rules for setup.

### Method
GET

### Endpoint
/setup/calendar/rules

### Response
#### Success Response (200 OK)
- **weeklyCalendarRule** (object): Details of the weekly calendar rule.
  - **creationTime** (integer)
  - **lastUpdateTime** (integer)
  - **priority** (integer)
  - **calendarDayOID** (string)
  - **finalRule** (boolean)
  - **randomTimeRange** (integer)
  - **dayType** (string)
  - **metadata** (string)
  - **startTimeHours** (integer)
  - **startTimeMinutes** (integer)
  - **endTimeHours** (integer)
  - **endTimeMinutes** (integer)
  - **localCalendarDay** (object): Represents a local calendar day.
    - **creationTime** (integer)
    - **lastUpdateTime** (integer)
    - **label** (string)
    - **type** (string)
    - **metadata** (string)
    - **oid** (string)
    - **dayTimeTriggers** (array): List of day time triggers.
      - **startActionGroupTimeTrigger** (object): Time trigger for starting an action group.
        - **triggerType** (string)
        - **id** (string)
        - **minutes** (integer)
        - **hours** (integer)
        - **metadata** (string)
        - **enabled** (boolean)
        - **duskOffset** (integer)
        - **dawnOffset** (integer)
        - **randomTimeOffset** (integer)
        - **actionGroupOID** (string)
        - **localActionGroup** (object): Represents a local action group.
          - **creationTime** (integer)
          - **lastUpdateTime** (integer)
          - **label** (string)
          - **metadata** (string)
          - **shortcut** (boolean)
          - **notificationTypeMask** (integer)
          - **notificationCondition** (string)
          - **notificationText** (string)
          - **notificationTitle** (string)
          - **targetEmailAddresses** (array of strings)
          - **targetPhoneNumbers** (array of strings)
          - **targetPushSubscriptions** (array of strings)
          - **actions** (array of objects): List of actions.
            - **deviceURL** (string): Device URL format (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])
            - **commands** (array of objects): List of commands.
              - **type** (integer)
              - **name** (string)
              - **parameters** (array of strings)
              - **sensitiveParametersIndexes** (array of integers)
              - **authentication** (string)
              - **delay** (integer)
          - **oid** (string)
  - **startYear** (integer)
  - **startMonth** (integer)
  - **startDay** (integer)
  - **endYear** (integer)
  - **endMonth** (integer)
  - **endDay** (integer)
  - **period** (integer)
  - **presenceFilter** (string)
  - **dayMask** (integer)
  - **oid** (string)

### Response Example
```json
{
  "weeklyCalendarRule": {
    "creationTime": 1612274610328,
    "lastUpdateTime": 1612274610329,
    "priority": 1,
    "calendarDayOID": "a calendar day OID",
    "finalRule": true,
    "randomTimeRange": 1,
    "dayType": "WORK_DAY",
    "metadata": "some metadata",
    "startTimeHours": 1,
    "startTimeMinutes": 1,
    "endTimeHours": 1,
    "endTimeMinutes": 1,
    "localCalendarDay": {
      "creationTime": 1612274610329,
      "lastUpdateTime": 1612274610329,
      "label": "a calendar day label",
      "type": "WINTER",
      "metadata": "some metadata",
      "oid": "the calendar day UUID",
      "dayTimeTriggers": [
        {
          "startActionGroupTimeTrigger": {
            "triggerType": "DUSK",
            "id": "an id",
            "minutes": 1,
            "hours": 1,
            "metadata": "some metadata",
            "enabled": false,
            "duskOffset": 1,
            "dawnOffset": 1,
            "randomTimeOffset": 8,
            "actionGroupOID": "an action group OID",
            "localActionGroup": {
              "creationTime": 1612274610329,
              "lastUpdateTime": 1612274610329,
              "label": "a managed action group label",
              "metadata": "some metadata",
              "shortcut": true,
              "notificationTypeMask": 1,
              "notificationCondition": "ALWAYS",
              "notificationText": "a notification text",
              "notificationTitle": "a notification title",
              "targetEmailAddresses": ["some target email addresses"],
              "targetPhoneNumbers": ["some target phone numbers"],
              "targetPushSubscriptions": ["some target push subscriptions"],
              "actions": [
                {
                  "deviceURL": "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])",
                  "commands": [
                    {
                      "type": 1,
                      "name": "a command name",
                      "parameters": ["some parameters"],
                      "sensitiveParametersIndexes": [1],
                      "authentication": "an authentication",
                      "delay": 1
                    }
                  ]
                }
              ],
              "oid": "the managed action group UUID"
            }
          }
        }
      ]
    },
    "startYear": 1,
    "startMonth": 1,
    "startDay": 1,
    "endYear": 1,
    "endMonth": 1,
    "endDay": 1,
    "period": 1,
    "presenceFilter": "NO_FILTER",
    "dayMask": 1,
    "oid": "the weekly calendar rule UUID"
  }
}
```
```