REST Resources

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

The following operations are supported on this resource:

  • GET - Get a single domain and it's top-level children
  • PUT - Update domain attributes
  • DELETE - Delete the domain (Async)
GET /domains/{id} Version 1

Get a single domain and it's top-level children.

Sample Usage

GET /domains/{id}


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path ID Y
  • Sample Output XML:
    <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}">
         <write-enabled>Boolean</write-enabled>
         <id>Integer</id>
         <child-count>Integer</child-count>
         <modified-at>String</modified-at>
         <created-at>String</created-at>
         <description>String</description>
         <name>String</name>
         <children uri="/api/space/domain-management/domains/{id}/children">
               <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}/children/{id}">
                   <id>Integer</id>
                   <name>String</name>
                   <child-count>Integer</child-count>
                   <created-at>String</created-at>
                   <description>String</description>
                   <write-enabled>Boolean</write-enabled>
                   <child-lock>Boolean</child-lock>
                   <no-of-assigned-users>Integer</no-of-assigned-users>
                   <no-of-assigned-remote-profile>Integer</no-of-assigned-remote-profile>
               </domain>
         </children>
         <child-lock>Boolean</child-lock>
         <no-of-assigned-users>Integer</no-of-assigned-users>
         <no-of-assigned-remote-profile>Integer</no-of-assigned-remote-profile>
         <users href="/api/space/domain-management/domains/{id}/users"/>
         <profiles href="/api/space/domain-management/domains/{id}/profiles"/>
         <devices href="/api/space/domain-management/domains/{id}/devices"/>
    </domain>

  • Sample Output JSON:
    {
       "domain" : {
         "@href" : "/api/space/domain-management/domains/{id}" ,
         "@uri" : "/api/space/domain-management/domains/{id}" ,
         "write-enabled" : "Boolean" ,
         "id" : "Integer" ,
         "child-count" : "Integer" ,
         "modified-at" : "String" ,
         "created-at" : "String" ,
         "description" : "String" ,
         "name" : "String" ,
         "children" : {
           "@uri" : "/api/space/domain-management/domains/{id}/children" ,
           "domain" : {
             "@href" : "/api/space/domain-management/domains/{id}" ,
             "@uri" : "/api/space/domain-management/domains/{id}/children/{id}" ,
             "id" : "Integer" ,
             "name" : "String" ,
             "child-count" : "Integer" ,
             "created-at" : "String" ,
             "description" : "String" ,
             "write-enabled" : "Boolean" ,
             "child-lock" : "Boolean" ,
             "no-of-assigned-users" : "Integer" ,
             "no-of-assigned-remote-profile" : "Integer"
           }
         } ,
         "child-lock" : "Boolean" ,
         "no-of-assigned-users" : "Integer" ,
         "no-of-assigned-remote-profile" : "Integer" ,
         "users" : {
           "@href" : "/api/space/domain-management/domains/{id}/users"
         } ,
         "profiles" : {
           "@href" : "/api/space/domain-management/domains/{id}/profiles"
         } ,
         "devices" : {
           "@href" : "/api/space/domain-management/domains/{id}/devices"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: DefaultRead, CreateProfile, ModifyProfile, CreateUser, ModifyUser

    PUT /domains/{id} Version 1

    Update domain attributes.

    Sample Usage

    PUT /domains/{id}


    • Parameters:
      Name Type URI Type Description Required
      domain Integer Path Domain Y
  • Sample Input XML:
    <domain>
         <description>String</description>
         <name>String</name>
         <child-lock>Boolean</child-lock>
    </domain>

  • Sample Output XML:
    <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}">
         <write-enabled>Boolean</write-enabled>
         <id>Integer</id>
         <child-count>Integer</child-count>
         <modified-at>String</modified-at>
         <created-at>String</created-at>
         <description>String</description>
         <name>String</name>
         <children uri="/api/space/domain-management/domains/{id}/children">
               <domain href="/api/space/domain-management/domains/{id}" uri="/api/space/domain-management/domains/{id}/children/{id}">
                   <child-count>Integer</child-count>
                   <write-enabled>Boolean</write-enabled>
                   <id>Integer</id>
                   <name>String</name>
                   <child-lock>Boolean</child-lock>
               </domain>
         </children>
         <child-lock>Boolean</child-lock>
    </domain>

  • Sample Input JSON:
    {
       "domain" : {
         "description" : "String" ,
         "name" : "String" ,
         "child-lock" : "Boolean"
       }
    }

  • Sample Output JSON:
    {
       "domain" : {
         "@href" : "/api/space/domain-management/domains/{id}" ,
         "@uri" : "/api/space/domain-management/domains/{id}" ,
         "write-enabled" : "Boolean" ,
         "id" : "Integer" ,
         "child-count" : "Integer" ,
         "modified-at" : "String" ,
         "created-at" : "String" ,
         "description" : "String" ,
         "name" : "String" ,
         "children" : {
           "@uri" : "/api/space/domain-management/domains/{id}/children" ,
           "domain" : {
             "@href" : "/api/space/domain-management/domains/{id}" ,
             "@uri" : "/api/space/domain-management/domains/{id}/children/{id}" ,
             "child-count" : "Integer" ,
             "write-enabled" : "Boolean" ,
             "id" : "Integer" ,
             "name" : "String" ,
             "child-lock" : "Boolean"
           }
         } ,
         "child-lock" : "Boolean"
       }
    }

    • Access Control

    The following capabilities are required to access this API: ModifyDomain

    DELETE /domains/{id} Version 2

    Delete the domain (Async).

    Sample Usage

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

    DELETE /domains/{id}?queue=<queue>&schedule=<schedule>


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


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path 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