SMsmartthings
Capabilities

Get a Capability Localization by Locale

Changed on

Retrieve translated values in a desired language (i.e. locale) for a Capability. A locale is the abbreviated, internationalization code for the requested language.

get/capabilities/{capabilityId}/{capabilityVersion}/i18n/{locale}

Request

Query parameters

manufacturerNamestring

Secondary namespacing key for grouping presentations (formerly mnmn)

presentationIdstring required

System generated identifier that corresponds to a device presentation (formerly vid)

Response

successful return of a Capability localization

tagstring required

The tag of the locale as defined in RFC bcp47.

labelstring

A localized label for the capability

descriptionstring

A localized description of the capability

attributesobject

Map of attribute name to localizations

commandsobject

Map of command name to localizations

Example response

{
  "tag": "en",
  "label": "Modo de ar condicionado",
  "description": "Modo de ar condicionado",
  "attributes": {
    "airConditionerMode": {
      "displayTemplate": "é suposto {{device.label}} a palavra {{attribute}} igual a {{value}}.",
      "label": "Este é o modo de ar condicionado",
      "i18n": {
        "value": {
          "auto": {
            "label": "Auto",
            "description": "Este é o modo automático"
          },
          "cool": {
            "label": "Frio",
            "description": "Este é o modo frio"
          }
        }
      }
    }
  },
  "commands": {
    "setAirConditionerMode": {
      "arguments": {
        "mode": {
          "i18n": {
            "auto": {
              "label": "Auto"
            },
            "cool": {
              "label": "Frio"
            }
          }
        }
      }
    }
  }
}

Changes

  • 6acc46f51053Revision changes
    • breaking

      added the new required query request parameter presentationId

    • info

      added the new optional query request parameter manufacturerName