Inventory Report

Generate a new report

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/inventory_report/

Request to generate a new inventory report. It will be be sent by email.

Please note that the report is generated by the AS and not by the APIO.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/inventory_report/ HTTP/1.1
Host: example.com

{
     "reportDeliveryEmailAddress": "user1@example.com",
     "includeUsers": true,
     "includeServices": true,
     "includeDns": false,
     "includeAccessDevices": true,
     "includeDepartments": false
}
Request JSON Object:

  • reportDeliveryEmailAddress (string) – (Required) the destination email address where to send the report.

  • includeUsers (boolean) – (Optional) Include Users information. Default False.

  • includeServices (boolean) – (Optional) Include Services information. Default False.

  • includeDns (boolean) – (Optional) Include Phone Numbers information. Default False.

  • includeAccessDevices (boolean) – (Optional) Include Access Devices (aka Phones most of the time) information. Default False.

  • includeDepartments (boolean) – (Optional) Include Departments information. Default False.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
}
Status Codes: