REST Resources

/api/space/device-management/devices/{device-id}/activate-modeled-device

The following operations are supported on this resource:

  • POST - Activate modeled device
  • POST - Activate modeled device
POST /devices/{device-id}/activate-modeled-deviceVersion 1

Sample Usage

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

POST /devices/{device-id}/activate-modeled-device?queue=<queue>&schedule=<schedule>


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPath   Y
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <activate-modeled-device-device-init-request>
         <connection-profile href="/api/space/device-management/modeled-device-management/connection-profiles/{id}">
               <name>String</name>
         </connection-profile>
         <static-ip>String</static-ip>
         <subnet-id>String</subnet-id>
         <gateway>String</gateway>
         <serial-number-validation>Boolean</serial-number-validation>
         <user-name>String</user-name>
         <password>String</password>
         <key-based>Boolean</key-based>
         <serial-number>String</serial-number>
         <Configuration-update-type>AUTOMATIC</Configuration-update-type>
    </activate-modeled-device-device-init-request>

  • Sample Input JSON:
    {
       "activate-modeled-device-device-init-request" : {
         "connection-profile" : {
           "@href" :
           "/api/space/device-management/modeled-device-management/connection-profiles/{id}"
           ,
           "name" : "String"
         } ,
         "static-ip" : "String" ,
         "subnet-id" : "String" ,
         "gateway" : "String" ,
         "serial-number-validation" : "Boolean" ,
         "user-name" : "String" ,
         "password" : "String" ,
         "key-based" : "Boolean" ,
         "serial-number" : "String" ,
         "Configuration-update-type" : "AUTOMATIC"
       }
    }

  • Access Control

    The following capabilities are required to access this API: ManageActivation

    POST /devices/{device-id}/activate-modeled-deviceVersion 1

    Sample Usage

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

    POST /devices/{device-id}/activate-modeled-device?queue=<queue>&schedule=<schedule>


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


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      device-idIntegerPath   Y
      queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
      schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <activate-modeled-device-space-init-request>
         <host>String</host>
         <user-name>String</user-name>
         <password>String</password>
         <key-based>Boolean</key-based>
         <use-nat>Boolean</use-nat>
         <create-new-user>Boolean</create-new-user>
         <new-user-name>String</new-user-name>
         <new-user-password>String</new-user-password>
         <new-user-key-based>Boolean</new-user-key-based>
         <serial-number-validation>Boolean</serial-number-validation>
         <serial-number>String</serial-number>
         <configuration-update-type>AUTOMATIC</configuration-update-type>
    </activate-modeled-device-space-init-request>

  • Sample Input JSON:
    {
       "activate-modeled-device-space-init-request" : {
         "host" : "String" ,
         "user-name" : "String" ,
         "password" : "String" ,
         "key-based" : "Boolean" ,
         "use-nat" : "Boolean" ,
         "create-new-user" : "Boolean" ,
         "new-user-name" : "String" ,
         "new-user-password" : "String" ,
         "new-user-key-based" : "Boolean" ,
         "serial-number-validation" : "Boolean" ,
         "serial-number" : "String" ,
         "configuration-update-type" : "AUTOMATIC"
       }
    }

  • Access Control

    The following capabilities are required to access this API: ManageActivation