# Samsung SmartThings

> Read devices, rooms, locations, modes, scenes and rules; control devices and modes.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/samsung-smartthings

## Actions

### Create room

Create room.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Allowed (`allowed`, text): If set to true, the response may contain the allowed list property. Note that setting this to true may significantly slow the response time. If you are creating a room for your own account, then you know you will have all these permissions and can avoid the trouble of passing in this parameter.
- Name (`name`, text, required): A name for the room (e.g. Living Room)
- Indoor map (`indoor_map`, object): Data used for indoor map

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "allowed": [],
    "backgroundImage": "example",
    "created": "example",
    "indoorMap": {
      "color": "example",
      "mapRoomId": "example"
    },
    "lastModified": "example",
    "locationId": "example",
    "name": "example",
    "roomId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete room

Delete room.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Room (`room_id`, text, required): The ID of the Room.

**Outputs**: Response.

- `data` (object): An empty object response.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Execute scene

Execute scene.

**Inputs**

- Location (`location_id`, text): The location of a scene.
- Scene (`scene_id`, text, required): The ID of the Scene.

**Outputs**: Response.

- `data` (object): {"status": "success"}
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "status": "success"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get capability status

Get capability status.

**Inputs**

- Device (`device_id`, text, required): The Device ID
- Component (`component_id`, text, required): The name of the component.
- Capability (`capability_id`, text, required): The ID of the capability

**Outputs**: Response.

- `data` (object): A map of attribute name to attribute state.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get component status

Get component status.

**Inputs**

- Device (`device_id`, text, required): The Device ID
- Component (`component_id`, text, required): The name of the component.

**Outputs**: Response.

- `data` (object): A map of capabilityId to capability status.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get current mode

Get current mode.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "allowed": [],
    "id": "example",
    "label": "example",
    "locationId": "example",
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device

Get device.

**Inputs**

- Device (`device_id`, text, required): The Device ID
- Include status (`include_status`, true/false): Include the status of the device's capabilities, if permission is adequate to view them. This requires `r:devices` permission.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "allowed": [],
    "app": {
      "externalId": "example",
      "installedAppId": "example",
      "profile": {
        "id": "example"
      }
    },
    "ble": {},
    "bleD2D": {
      "advertisingId": "example",
      "bleDeviceType": "example",
      "cipher": "example",
      "configurationUrl": "example",
      "configurationVersion": "example",
      "encryptionKey": "example",
      "gattCipher": "example",
      "identifier": "example",
      "metadata": {}
    },
    "brandId": "example",
    "childDevices": [],
    "components": [],
    "createTime": "example",
    "deviceId": "example",
    "deviceManufacturerCode": "example",
    "deviceNetworkType": "example",
    "deviceTypeId": "example",
    "deviceTypeName": "example",
    "dth": {
      "completedSetup": false,
      "deviceNetworkType": "example",
      "deviceTypeId": "example",
      "deviceTypeName": "example",
      "executingLocally": false,
      "fingerprintId": "example",
      "fingerprintType": "DTH",
      "hubId": "example",
      "installedGroovyAppId": "example",
      "networkId": "example",
      "networkSecurityLevel": "UNKNOWN"
    },
    "edgeChild": {
      "driverId": "example",
      "executingLocally": false,
      "fingerprintId": "example",
      "fingerprintType": "DTH",
      "hubId": "example",
      "networkId": "example",
      "parentAssignedChildKey": "example",
      "provisioningState": "PROVISIONED"
    },
    "executionContext": "LOCAL",
    "group": {
      "devices": [],
      "groupName": "example",
      "groupType": "UNDETERMINED"
    },
    "healthState": {
      "lastUpdatedDate": "example",
      "state": "ONLINE"
    },
    "hub": {
      "driverId": "example",
      "firmwareVersion": "example",
      "hubData": {
        "childDeviceAvailability": "Available",
        "edgeDriverSupportedEndpointApps": {
          "apps": []
        },
        "edgeDriversAvailability": "Available",
        "enrollmentChannel": "PUBLIC",
        "failoverAvailability": "Available",
        "hardwareId": "example",
        "hardwareType": "example",
        "hedgeTlsCertificate": "example",
        "hub2hubSupportMatrix": {
          "capabilities": []
        },
        "hubLocalApiAvailability": "Available",
        "hubLocalApiJwkOfflineRetentionSeconds": 1,
        "hubReplaceAvailability": "Available",
        "lanAvailability": "Available",
        "localIP": "example",
        "localVirtualDeviceAvailability": "Available",
        "macAddress": "example",
        "matterAvailability": "Available",
        "matterCommissionerSupport": {
          "supportedModes": [],
          "version": 1
        },
        "matterDeviceDiagnosticsAvailability": "Available",
        "matterRendezvousHedgeSupported": false,
        "matterSoftwareComponentVersion": "example",
        "otaEnable": "example",
        "primaryHubDeviceId": "example",
        "primarySupportAvailability": "Available",
        "repeaterReachability": "Unknown",
        "secondarySupportAvailability": "Available",
        "serialNumber": "example",
        "threadAvailability": "Available",
        "threadRequiresExternalHardware": false,
        "wifiSsid": "example",
        "zigbee3": false,
        "zigbeeAvailability": "Available",
        "zigbeeChannel": "example",
        "zigbeeDeviceDiagnosticsAvailability": "Available",
        "zigbeeEui": "example",
        "zigbeeFirmware": "example",
        "zigbeeManualFirmwareUpdateSupported": false,
        "zigbeeNodeID": "example",
        "zigbeeOta": "DISABLED",
        "zigbeePanId": "example",
        "zigbeeRadioDetected": false,
        "zigbeeRadioEnabled": false,
        "zigbeeRadioFunctional": false,
        "zigbeeRequiresExternalHardware": false,
        "zigbeeUnsecureRejoin": false,
        "zwaveAvailability": "Available",
        "zwaveHomeID": "example",
        "zwaveNodeID": "example",
        "zwaveRadioDetected": false,
        "zwaveRadioEnabled": false,
        "zwaveRadioFunctional": false,
        "zwaveRegion": "example",
        "zwaveS2": false,
        "zwaveStaticDsk": "example",
        "zwaveSucID": "example",
        "zwaveVersion": "example"
      },
      "hubDrivers": [],
      "hubEui": "example"
    },
    "indoorMap": {
      "coordinates": [
        1,
        1,
        1
      ],
      "data": {},
      "rotation": [
        1,
        1,
        1
      ],
      "visible": false
    },
    "ir": {
      "childDevices": [],
      "functionCodes": {
        "default": "example"
      },
      "irCode": "example",
      "metadata": {},
      "ocfDeviceType": "example",
      "parentDeviceId": "example",
      "profileId": "example"
    },
    "irOcf": {
      "childDevices": [],
      "functionCodes": {
        "default": "example"
      },
      "irCode": "example",
      "metadata": {},
      "ocfDeviceType": "example",
      "parentDeviceId": "example",
      "profileId": "example"
    },
    "label": "example",
    "lan": {
      "driverId": "example",
      "executingLocally": false,
      "fingerprintId": "example",
      "fingerprintType": "DTH",
      "hubId": "example",
      "networkId": "example",
      "provisioningState": "PROVISIONED"
    },
    "locationId": "example",
    "manufacturerName": "example",
    "matter": {
      "driverId": "example",
      "endpoints": [],
      "executingLocally": false,
      "fingerprintId": "example",
      "fingerprintType": "DTH",
      "hubId": "example",
      "listeningType": "ALWAYS",
      "networkId": "example",
      "productId": 1,
      "provisioningState": "PROVISIONED",
      "serialNumber": "example",
      "supportedNetworkInterfaces": [],
      "syncDrivers": false,
      "uniqueId": "example",
      "vendorId": 1,
      "version": {
        "hardware": 1,
        "hardwareLabel": "example",
        "software": 1,
        "softwareLabel": "example"
      }
    },
    "mqtt": {
      "authCodeRequired": false,
      "executingLocally": false,
      "hubId": "example",
      "transferCandidate": false
    },
    "name": "example",
    "ocf": {
      "additionalAuthCodeRequired": false,
      "firmwareVersion": "example",
      "hwVersion": "example",
      "lastSignupTime": "example",
      "locale": "example",
      "manufacturerName": "example",
      "modelCode": "example",
      "modelNumber": "example",
      "name": "example",
      "ocfDeviceType": "example",
      "platformOS": "example",
      "platformVersion": "example",
      "specVersion": "example",
      "transferCandidate": false,
      "vendorId": "example",
      "vendorResourceClientServerVersion": "example",
      "verticalDomainSpecVersion": "example"
    },
    "ownerId": "example",
    "parentDeviceId": "example",
    "presentationId": "example",
    "productId": "example",
    "profile": {
      "id": "example"
    },
    "relationships": [],
    "restrictionTier": 1,
    "roomId": "example",
    "type": "BLE",
    "viper": {
      "endpointAppId": "example",
      "hwVersion": "example",
      "manufacturerName": "example",
      "modelName": "example",
      "swVersion": "example",
      "uniqueIdentifier": "example"
    },
    "virtual": {
      "commandMappings": {
        "commands": []
      },
      "driverId": "example",
      "executingLocally": false,
      "hubId": "example",
      "name": "example"
    },
    "zigbee": {
      "driverId": "example",
      "eui": "example",
      "executingLocally": false,
      "fingerprintId": "example",
      "fingerprintType": "DTH",
      "hubId": "example",
      "networkId": "example",
      "provisioningState": "PROVISIONED"
    },
    "zwave": {
      "driverId": "example",
      "executingLocally": false,
      "fingerprintId": "example",
      "fingerprintType": "DTH",
      "hubId": "example",
      "manufacturerId": 1,
      "networkId": "example",
      "networkSecurityLevel": "UNKNOWN",
      "productId": 1,
      "productType": 1,
      "provisioningState": "PROVISIONED"
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device health

Get device health.

**Inputs**

- Device (`device_id`, text, required): The Device ID

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "deviceId": "example",
    "lastUpdatedDate": "example",
    "state": "ONLINE"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device status

Get device status.

**Inputs**

- Device (`device_id`, text, required): The Device ID

**Outputs**: Response.

- `data` (object): The status of a device.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "components": {},
    "deviceId": "example",
    "healthState": {
      "lastUpdatedDate": "example",
      "state": "ONLINE"
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get location

Get location.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Allowed (`allowed`, text): If set to true, the items in the response may contain the allowed list property

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "additionalProperties": {},
    "allowed": [],
    "backgroundImage": "example",
    "countryCode": "example",
    "created": "example",
    "lastModified": "example",
    "latitude": 1,
    "locale": "example",
    "locationId": "example",
    "longitude": 1,
    "name": "example",
    "parent": {
      "id": "example",
      "type": "LOCATIONGROUP"
    },
    "regionRadius": 1,
    "temperatureScale": "example",
    "timeZoneId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get room

Get room.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Room (`room_id`, text, required): The ID of the Room.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "allowed": [],
    "backgroundImage": "example",
    "created": "example",
    "indoorMap": {
      "color": "example",
      "mapRoomId": "example"
    },
    "lastModified": "example",
    "locationId": "example",
    "name": "example",
    "roomId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get rule

Get rule.

**Inputs**

- Rule (`rule_id`, text, required): The rule ID
- Location (`location_id`, text, required): The ID of the Location containing the Rule you wish to retrieve.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "actions": [],
    "allowed": [],
    "creator": "SMARTTHINGS",
    "dateCreated": "example",
    "dateExecuted": "example",
    "dateUpdated": "example",
    "executionLocation": "Cloud",
    "id": "example",
    "name": "example",
    "ownerId": "example",
    "ownerType": "Location",
    "sequence": {
      "actions": "Serial"
    },
    "status": "Enabled",
    "timeZoneId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List devices

List devices.

**Inputs**

- Capability (`capability`, list): The device capabilities to filter the results by. The capabilities are treated as an "and" so all capabilities must be present.
- Location (`location_id`, list): The device locations to filter the results by.
- Device (`device_id`, list): The device IDs to filter the results by.
- Capabilities mode (`capabilities_mode`, text): Treat all capability filter query params as a logical "or" or "and" with a default of "and". One of: `or`, `and`.
- Include restricted (`include_restricted`, true/false): Restricted devices are hidden by default. This query parameter will reveal them. Device status will not be provided if the token does not have sufficient access level to view the device status even if includeStatus parameter is set to true.
- Access level (`access_level`, number): Only list devices accessible by the given accessLevel.
- Include allowed actions (`include_allowed_actions`, true/false): Include the actions permitted by this token's access for each individual resource.
- Include status (`include_status`, true/false): Include the status of the device's capabilities, if permission is adequate to view them. This requires `r:devices` permission.
- Include health (`include_health`, true/false): Include the health status of the device. Requires `r:devices` permission.
- Include hidden devices (`include_hidden_devices`, true/false): Include hidden devices in the results. Requires `r:devices` permission.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): A paginated array of devices.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "_links": {
      "next": {
        "href": "example"
      },
      "previous": {
        "href": "example"
      }
    },
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List locations

List locations.

**Inputs**

- Allowed (`allowed`, text): If set to true, the items in the response may contain the allowed list property
- Limit (`limit`, number): Maximum number of Locations returned in a paged result set.
- Page (`page`, text): Next page result set key.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Represents a single page of Locations available in a user account.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "_links": {
      "next": {
        "href": "example"
      },
      "previous": {
        "href": "example"
      }
    },
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List modes

List modes.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List rooms

List rooms.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Represents a single page of Rooms available in a Location.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "_links": {
      "next": {
        "href": "example"
      },
      "previous": {
        "href": "example"
      }
    },
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List rules

List rules.

**Inputs**

- Location (`location_id`, text, required): The ID of the Location you want to list Rules for.
- Include all parents (`include_all_parents`, text): If set to true, all rules are returned
- Max (`max`, number): The max number of Rules to fetch
- Offset (`offset`, number): The start index of Rules to fetch
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): An array of Rules
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "_links": {
      "next": {
        "href": "example"
      },
      "previous": {
        "href": "example"
      }
    },
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List scenes

List scenes.

**Inputs**

- Location (`location_id`, text): The location of a scene.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "_links": {
      "next": {
        "href": "example"
      },
      "previous": {
        "href": "example"
      }
    },
    "items": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Send device commands

Send device commands.

**Inputs**

- Device (`device_id`, text, required): The Device ID
- Ordered (`ordered`, true/false): This parameter has been deprecated. Functionality is not guaranteed. Specifies whether the command should be executed in order or asynchronously.
- Commands (`commands`, list, required): An array of commands to execute on the device.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Set current mode

Set current mode.

**Inputs**

- Location (`location_id`, text, required): A unique location identifier. This is not guaranteed to be a valid UUID.
- Mode (`mode_id`, text, required): Update the current Mode for this Location to the given Mode ID.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "id": "example",
    "label": "example",
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
