{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book xAPI API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "xAPI",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/xapi/status",
            "params": [
              {
                "name": "deviceId",
                "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM",
                "type": "query",
                "description": "The unique identifier for the Webex RoomOS Device."
              },
              {
                "name": "name",
                "value": "audio.volume",
                "type": "query",
                "description": "A list of status expressions used to query the Webex RoomOS Device. See the [xAPI section of the Device Developers Guide](/docs/api/guides/device-developers-guide#xapi) for a description of status expressions. A request can contain at most 10 different status expressions."
              }
            ]
          },
          "docs": "Query the current status of the Webex RoomOS Device. You specify the target device in the `deviceId` parameter in the URI. The target device is queried for statuses according to the expression in the `name` parameter.\n\nSee the [xAPI section of the Device Developers Guide](/docs/api/guides/device-developers-guide#xapi) or the [xAPI Command Reference](https://roomos.cisco.com/xapi) for a description of status expressions."
        },
        {
          "info": {
            "name": "Query Schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/xapi/schema",
            "params": [
              {
                "name": "deviceId",
                "value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM",
                "type": "query",
                "description": "A list of device IDs to query schemas from. A request can contain at most 5 device IDs."
              },
              {
                "name": "status",
                "value": "Conference.*",
                "type": "query",
                "description": "A list of status key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_statuses` scope."
              },
              {
                "name": "command",
                "value": "UserInterface.*",
                "type": "query",
                "description": "A list of command key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_commands` scope."
              }
            ]
          },
          "docs": "Query the schema for statuses and commands of Webex RoomOS Devices. You specify the target devices in the `deviceId` parameter in the URI. Querying command schemas requires the `spark:xapi_commands` scope and querying status schemas requires the `spark:xapi_statuses` scope.\n\nIf no `status` or `command` expressions are specified, the full schema is returned, including both status and command schemas. If you specify any expression, the response is limited to only the types you queried for. For exa"
        },
        {
          "info": {
            "name": "Execute Command",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/xapi/command/:commandName",
            "params": [
              {
                "name": "commandName",
                "value": "Audio.Volume.Set",
                "type": "path",
                "description": "Command to execute on the Webex RoomOS Device."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Executes a command on the Webex RoomOS Device. Specify the command to execute in the `commandName` URI parameter.\n\nSee the [xAPI section of the Device Developers Guide](/docs/devices#xapi) for a description of command expressions."
        }
      ]
    }
  ],
  "bundled": true
}