SMsmartthings
InstalledSchemaApps

Get Devices By InstalledSchemaApp ID

Changed on

Get devices and app related info for a given isaId. If relogin is not required, the pageType will be set to "loggedIn" and SmartThings will return the isaId, devices, partnerName, appName and icons. If relogin is needed, the pageType will be set to "requiresLogin" and the "oauthLink" value will be populated in the response. For both pageTypes, if the integration is LAN-hybrid, driverId is also returned.

get/schema/installedapps/{isaId}

Request

Query parameters

redirectRequestedboolean

Response of getOauthCallback API depends on this query parameter. If true, returns an HTML page with redirect link else returns an HTML page with "connection successful/failed" text.

jsonRspRequestedboolean

This parameter supersedes the redirectRequested parameter if both are provided. If true, the API call to getOauthCallback requires an "Authorization" header with the same permission(s) as the one used in the call to this API. The response from getOauthCallback will also be a json object instead of an html page.

Response

Success

pageTypestring

Possible values - requiresLogin or loggedIn. These two values determine what fields are returned in this response. If value is "requiresLogin", "oAuthLink" is returned in the response. If value is "loggedIn", isaId, partnerName, appName, devices and icons are returned. For both values, if the integration is LAN-hybrid, driverId is also returned.

isaIdstring

isaId (Installed App Id)

endpointAppIdstring

endpoint app id of the installed smart app

partnerNamestring

partner or brand name eg LIFX Inc.

appNamestring

Connector name. eg Lifx (Connect)

iconstring

url of partner icon

icon2xstring

url of partner icon in 2x dimensions

icon3xstring

url of partner icon in 3x dimensions

locationIdstring

location of the installed smart app

oAuthLinkstring

generated oAuth link for the user to login to partner server. This will only be returned when the user is not logged in.

partnerSTConnection'connected' | 'disconnected'

connection status between partner and ST platform

stEulaFileNamestring

file name for the EULA PII page

stEulaLocksmithKeystring

locksmith key for EULA

driverIdstring

Unique identifier of the driver. This field will only be returned for LAN-hybrid integrations.

Changes