Capabilities

Owned by Nina Cardillo
10-Jan-2024

URI Definition

Method

URI and Fields

PUT
























iap/capabilities/customer/{id}/provision

Provisions all devices that belong to the specified customer. Devices that are connected to an unprovisioned edge server are skipped.

Argument

Argument             

Description                                                                                                  

id

(Required)  Customer ID.

Example

https://localhost/iap/capabilities/customer/81/provision                                           

  

iap/capabilities/customer/{id}/deprovision

Deprovisions all devices that belong to the specified customer.

Arguments

Argument             

Description                                                                                                  

id

(Required)  Customer ID.

Example

https://localhost/iap/capabilities/customer/81/deprovision                                      

  

iap/capabilities/gz/{id}/provision

Provisions all devices that belong to the specified geozone. Devices that are connected to an unprovisioned edge server are skipped.

Arguments

Argument             

Description                                                                                                  

id

(Required)  Geozone ID.

Query Parameter

Parameter            

Description                                                                                                  

recursive

(Optional) If set to true, devices from child geozones will also be
provisioned.

Example

https://localhost/iap/capabilities/gz/88/provision?recursive=true                           

iap/capabilities/gz/{id}/deprovision

Deprovisions all devices that belong to the specified geozone.

Arguments

Argument             

Description                                                                                                  

id

(Required)  Geozone ID.

Query Parameter

Parameter            

Description                                                                                                  

recursive

(Optional) If set to true, devices from child geozones will also be
deprovisioned.

Example

https://localhost/iap/capabilities/gz/88/deprovision?recursive=true                       

iap/capabilities/grp/{id}/provision

Provisions all devices that belong to the specified group. Devices that are connected to an unprovisioned edge server are skipped.

Argument

Argument             

Description                                                                                                  

id

(Required)  Group ID.

Example

https://localhost/iap/capabilities/grp/574/provision                                                   

iap/capabilities/grp/{id}/deprovision

Deprovisions all devices that belong to the specified group.

Argument

Argument             

Description                                                                                                  

id

(Required)  Group ID.

Example

https://localhost/iap/capabilities/grp/574/deprovision                                              

iap/capabilities/floorplan/{id}/provision

Provisions all devices that belong to the specified floor plan. Devices that are connected to an unprovisioned edge server are skipped.

Argument

Argument             

Description                                                                                                  

id

(Required)  Floorplan ID.

Example

https://localhost/iap/capabilities/floorplan/463/provision                                         

iap/capabilities/floorplan/{id}/deprovision

Deprovisions all devices that belong to the specified floor plan.

Argument

Argument             

Description                                                                                                  

id

(Required)  Floorplan ID.

Example

https://localhost/iap/capabilities/floorplan/463/deprovision                                    

iap/capabilities/floor/{id}/provision

Provisions all devices that belong to the specified floor. Devices that are connected to an unprovisioned edge server are skipped.

Argument

Argument             

Description                                                                                                  

id

(Required)  Floor ID.

Example

https://localhost/iap/capabilities/floor/464/provision                                                

iap/capabilities/floor/{id}/deprovision

Deprovisions all devices that belong to the specified floor.

Argument

Argument             

Description                                                                                                  

id

(Required)  Floor ID.

Example

https://localhost/iap/capabilities/floor/464/deprovision                                            

iap/capabilities/zone/{id}/provision

Provisions all devices that belong to the specified zone. Devices that are connected to an unprovisioned edge server are skipped.

Arguments

Argument             

Description                                                                                                  

id

(Required)  Zone ID.

Query Parameter

Parameter            

Description                                                                                                  

recursive

(Optional) If set to true, devices from child geozones will also be
deprovisioned.

Example

https://localhost/iap/capabilities/zone/467/provision?recursive=true                       

iap/capabilities/zone/{id}/deprovision

Deprovisions all devices that belong to the specified zone.

Arguments

Argument             

Description                                                                                                  

id

(Required)  Zone ID.

Query Parameter

Parameter            

Description                                                                                                  

recursive

(Optional) If set to true, devices from child geozones will also be
deprovisioned.

Example

https://localhost/iap/capabilities/zone/467/deprovision?recursive=true                       

Query Parameters

Optional query parameters can be used with your REST request.  Specifying queries is described under Queries and Parameters, Path Parameters, and Query Parameters.