/api/space/config-template-management/config-templates/{template-id}/device-associations

The following operation is supported on this resource:

  • GET - Get all device template associations for a specified configuration template
GET /config-templates/{template-id}/device-associationsVersion 1

This API gets all device template associations for a specified configuration template. Associations show which devices are associated with which templates, as well as other deployment, audit, and publishing information.

Sample Usage

GET /config-templates/{template-id}/device-associations


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    template-idIntegerPathThe ID of the configuration template. Y
  • Sample Output XML:
    <device-associations total="Integer" uri="/api/space/config-template-management/config-templates/{template-id}/device-associations">
         <device-association>
               <device-name>String</device-name>
               <current-template-ver>Integer</current-template-ver>
               <deploy-status>DEPLOYED</deploy-status>
               <audit-status>OUTOFSYNC</audit-status>
               <template-version>Integer</template-version>
               <published-template-version>Integer</published-template-version>
               <deployed-by>String</deployed-by>
               <domain-id>Integer</domain-id>
               <domain-name>String</domain-name>
               <audit-job-id>Integer</audit-job-id>
               <job-id>Integer</job-id>
               <publish-status>PUBLISHED</publish-status>
               <order-seq>Integer</order-seq>
               <device-id>Integer</device-id>
               <device href="/api/space/device-management/devices/{deviceId}"/>
               <deployment-job href="/api/space/job-management/{jobId}"/>
               <audit-job href="/api/space/job-management/{auditJobId}"/>
         </device-association>
    </device-associations>

  • Sample Output JSON:
    {
       "device-associations" : {
         "@total" : "Integer" ,
         "@uri" :
         "/api/space/config-template-management/config-templates/{template-id}/device-associations"
         ,
         "device-association" : {
           "device-name" : "String" ,
           "current-template-ver" : "Integer" ,
           "deploy-status" : "DEPLOYED" ,
           "audit-status" : "OUTOFSYNC" ,
           "template-version" : "Integer" ,
           "published-template-version" : "Integer" ,
           "deployed-by" : "String" ,
           "domain-id" : "Integer" ,
           "domain-name" : "String" ,
           "audit-job-id" : "Integer" ,
           "job-id" : "Integer" ,
           "publish-status" : "PUBLISHED" ,
           "order-seq" : "Integer" ,
           "device-id" : "Integer" ,
           "device" : {
             "@href" : "/api/space/device-management/devices/{deviceId}"
           } ,
           "deployment-job" : {
             "@href" : "/api/space/job-management/{jobId}"
           } ,
           "audit-job" : {
             "@href" : "/api/space/job-management/{auditJobId}"
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: AddDeployedDevices