Post accountsswitchdevice

Creates a SwitchDevice for the account of the logged in user. The requesting User must have the following rights to perform this task: Rights Required AuthRuleType.MANAGE_SYSTEM REQUIRED This operation returns a SwitchDevice value.

The requesting User must have the following rights to perform this task:

This operation returns a SwitchDevice value.

POST /accounts/switchdevice

Error

A valid request URL is required to generate request examples

201

{
  "sysidSwitchDeviceType": 12345,
  "sysidSwitchDevice": 12345,
  "sysidAccount": 12345,
  "deviceType": {
    "description": "...",
    "deviceResources": [
      {
        "name": "...",
        "sysidSwitchDeviceResource": 12345,
        "languageTagKey": "...",
        "description": "...",
        "sysidAttributeDataType": 12345
      },
      {
        "name": "...",
        "sysidSwitchDeviceResource": 12345,
        "languageTagKey": "...",
        "description": "...",
        "sysidAttributeDataType": 12345
      }
    ],
    "name": "...",
    "deviceUsers": [
      {
        "description": "...",
        "name": "...",
        "sysidSwitchDeviceUser": 12345,
        "sysidAttributeDataType": 12345,
        "languageTagKey": "..."
      },
      {
        "description": "...",
        "name": "...",
        "sysidSwitchDeviceUser": 12345,
        "sysidAttributeDataType": 12345,
        "languageTagKey": "..."
      }
    ],
    "sysidSwitchDeviceType": 12345,
    "languageTagKey": "..."
  },
  "name": "...",
  "comments": "..."
}

Body

application/json

: SwitchDeviceData

sysidSwitchDeviceType · integer<int32> · required

sysidAccount · integer<int32> · required

sysidSwitchDevice · integer<int32>

deviceType · SwitchDeviceType · object

Show child attributes

Example:

{
  "description": "...",
  "deviceResources": [
    {
      "name": "...",
      "sysidSwitchDeviceResource": 12345,
      "languageTagKey": "...",
      "description": "...",
      "sysidAttributeDataType": 12345
    },
    {
      "name": "...",
      "sysidSwitchDeviceResource": 12345,
      "languageTagKey": "...",
      "description": "...",
      "sysidAttributeDataType": 12345
    }
  ],
  "name": "...",
  "deviceUsers": [
    {
      "description": "...",
      "name": "...",
      "sysidSwitchDeviceUser": 12345,
      "sysidAttributeDataType": 12345,
      "languageTagKey": "..."
    },
    {
      "description": "...",
      "name": "...",
      "sysidSwitchDeviceUser": 12345,
      "sysidAttributeDataType": 12345,
      "languageTagKey": "..."
    }
  ],
  "sysidSwitchDeviceType": 12345,
  "languageTagKey": "..."
}

name · string

comments · string

Response

201 - application/json

SwitchDeviceData returnType com.agilquest.phoenix.shared.data.switchdevice.SwitchDeviceData

sysidSwitchDeviceType · integer<int32> · required

sysidAccount · integer<int32> · required

sysidSwitchDevice · integer<int32>

deviceType · SwitchDeviceType · object

Show child attributes

Example:

{
  "description": "...",
  "deviceResources": [
    {
      "name": "...",
      "sysidSwitchDeviceResource": 12345,
      "languageTagKey": "...",
      "description": "...",
      "sysidAttributeDataType": 12345
    },
    {
      "name": "...",
      "sysidSwitchDeviceResource": 12345,
      "languageTagKey": "...",
      "description": "...",
      "sysidAttributeDataType": 12345
    }
  ],
  "name": "...",
  "deviceUsers": [
    {
      "description": "...",
      "name": "...",
      "sysidSwitchDeviceUser": 12345,
      "sysidAttributeDataType": 12345,
      "languageTagKey": "..."
    },
    {
      "description": "...",
      "name": "...",
      "sysidSwitchDeviceUser": 12345,
      "sysidAttributeDataType": 12345,
      "languageTagKey": "..."
    }
  ],
  "sysidSwitchDeviceType": 12345,
  "languageTagKey": "..."
}

name · string

comments · string