SMsmartthings
Installedapps

Get an Installed App Configuration

Fetch a detailed install configuration model containing actual config entries / values.

get/installedapps/{installedAppId}/configs/{configurationId}

Request

Path parameters

installedAppIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

The ID of the installed application.

configurationIdstring uuid required

The ID of the install configuration

Headers

Authorizationstring string required

OAuth token

Response

An install configuration detail model.

installedAppIdstring uuid

The ID of the installed app.

configurationIdstring uuid

The ID to this configration instance.

configurationStatus'STAGED' | 'DONE' | 'AUTHORIZED' | 'REVOKED'

Denotes the current state of a configuration instance. 'STAGED' configuration is used during active modification to config. A configuration is marked 'DONE' once it is deemed finished. At this point it is immutable, meaning it can't be changed. A status of 'AUTHORIZED' means the apps permissions have been authorized by the consumer. Installed Apps in 'AUTHORIZED' state are fully installed and used by the SmartThings platform. A status of 'REVOKED' means the apps permissions have been revoked.

configConfigMap

A multi-map of configurations for an Installed App. The map 'key' is the configuration name and the 'value' is an array of ConfigEntry models each containing a value and associated permissions. The config key is alpha-numeric, may contain dashes, underscores, periods, and must be less then 50 characters long.

createdDatestring date-time

A UTC ISO-8601 Date-Time String

lastUpdatedDatestring date-time

A UTC ISO-8601 Date-Time String

Example response

{
  "installedAppId": "8885b9c3-a50d-427e-ad07-d7a2f94421af",
  "configurationId": "c71b0a5b-7dab-41fe-b75f-7cf30246468e",
  "configurationStatus": "AUTHORIZED",
  "createdDate": "2017-05-19T12:39:37Z",
  "lastUpdatedDate": "2017-05-19T12:39:37Z",
  "config": {
    "switches": [
      {
        "valueType": "DEVICE",
        "deviceConfig": {
          "deviceId": "5ccbf4ba-7b5f-4eb3-85b8-ab8705ff8d61",
          "componentId": "main",
          "permissions": [
            "r:devices:5ccbf4ba-7b5f-4eb3-85b8-ab8705ff8d61"
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.