REST Resources

/api/space/domain-management/domains/{domian-id}/devices

The following operations are supported on this resource:

  • GET - Get all the devices by Domain ID
  • POST - Assign To Domain Job
GET /domains/{domian-id}/devices Version 3

Get all the devices by Domain ID.

Sample Usage

GET /domains/{domian-id}/devices


  • Parameters:
    Name Type URI Type Description Required
    domian-id Integer Path Domian ID Y
  • Sample Output XML:
    <devices total="1" uri="/api/space/domain-management/domains/32769/devices">
         <device href="/api/space/device-management/devices/589838" >
               <os-version>11.4R8.5</os-version>
               <device-name>EX_Device</device-name>
               <managed-status>In Sync</managed-status>
               <platform>EX4200-24T</platform>
               <domain-id>32769</domain-id>
               <id>589838</id>
               <name>EX_Device</name>
               <ip-address>192.168.27.72</ip-address>
         </device>
    </devices>

  • Sample Output JSON:
    {
       "devices" : {
         "@total" : "1" ,
         "@uri" : "/api/space/domain-management/domains/32769/devices" ,
         "device" : {
           "@href" : "/api/space/device-management/devices/589838" ,
           "os-version" : "11.4R8.5" ,
           "device-name" : "EX_Device" ,
           "managed-status" : "In Sync" ,
           "platform" : "EX4200-24T" ,
           "domain-id" : 32769 ,
           "id" : 589838 ,
           "name" : "EX_Device" ,
           "ip-address" : "192.168.27.72"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: ReadDevices

    POST /domains/{domian-id}/devices Version 3

    Assign To Domain Job.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /domains/{domian-id}/devices?queue=<queue>&schedule=<schedule>&assign-with-warning=<assign-with-warning>&queue-resource=<queue-resource>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      domain-id Integer Path Domain ID Y
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
      assign-with-warning Boolean Query Assign With Warning Y
      queue-resource String Query Queue Resource Y
  • Sample Input XML:
    <assign-devices>
         <devices>
               <device href="/api/space/device-management/devices/589838"/>
         </devices>
    </assign-devices>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/688128">
      <id>688128</id>
    </task>

  • Sample Input JSON:
    {
       "assign-devices" : {
         "devices" : {
           "device" : {
             "@href" : "/api/space/device-management/devices/589838"
           }
         }
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href":"/api/space/job-management/jobs/688128",
        "id":688128
      }
    }

    • Access Control

    The following capabilities are required to access this API: AssignDevice2Domain