- Created by Avi Falah, last modified by Meytal Ben-Tzvi on Mar 09, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 13 Next »
Get / Update / Execute / Delete reports
Authentication: Basic authentication
Authorization: Any user allowed using Reports, see:
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}}
GET Retrieve All Reports
URL:
GET - https://{{dpodHostname}}
/op/api/v2/reports/{{productView}}
Request - None.
Parameters:
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful | { "resultCode": "SUCCESS", "resultMessage": "Reports retrieved successfully", "result": { "reports": [{ "name": "API Latency Report", "description": "API Latency", "productView": "APIC", "apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856", "indexSets": "apic-log", "documentType": "APIC_LOGICAL_TRANS", "jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }", "schedule": "", "recipients": [], "adHocFilterTypes": ["TIME", "DEVICE",....], "filtersParameters": { "timeRangeType": "recent",.....}, "lastUpdateTimeInMillis": 1646655197926, "lastUpdateUserName": "admin", "esHeadersDictionary": "" }, {....} ] } } | resultCode → SUCCESS resultMessage → “Reports retrieved successfully” result → list of all reports and their data. For report parameters info click here: Reports REST API - Message Structure |
GET Get Specific Report Details
URL:
GET - https://{{dpodHostname}}
/op/api/v2/report/{{productView}}
/{{reportApiReferenceId}}
Request - None.
Parameters:
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId (can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful | { "resultCode": "SUCCESS", "resultMessage": "Report retrieved successfully", "result": { "name": "<report name>", "description": "<report description>", "productView": "<report product view>", "apiReference": "<report uuid>", "indexSets": "<report indexSet>", "documentType": "<report documentType>", "jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }", "schedule": "", "recipients": [], "adHocFilterTypes": ["TIME", "DEVICE",....], "filtersParameters": { "timeRangeType": "recent",.....}, "lastUpdateTimeInMillis": 1644768927839, "lastUpdateUserName": "Installer", "esHeadersDictionary": "" } } | resultCode → SUCCESS resultMessage → “Report retrieved successfully” result → The report data. For report parameters info click here: Reports REST API - Message Structure |
POST Duplicate Report
URL:
POST - https://{{dpodHostname}}
/op/api/v2/report/{{productView}}
/{{reportApiReferenceId}}
/duplicate
Request - None.
Parameters:
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to duplicate ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful | { "resultCode": "SUCCESS", "resultMessage": "Report duplicated successfully", "result": { "name": "<source report name> Copy", "description": "<source report description>", "productView": "<source report productView>", "apiReference": "<New unique report uuid>", "indexSets": "<source report indexSet>", "documentType": "<source report documentType>", "jsonQuery": "<source report query>", "schedule": "", "recipients": [], "adHocFilterTypes": ["TIME", "DEVICE",....], "filtersParameters": { "timeRangeType": "recent",.....}, "lastUpdateTimeInMillis": 1646826210928, "lastUpdateUserName": "<current userName>", "esHeadersDictionary": "" } } | resultCode → SUCCESS resultMessage → “Report duplicated successfully” result → The report data. For report parameters info click here: Reports REST API - Message Structure |
POST Execute (Async) Report
URL:
POST - https://{{dpodHostname}}
/op/api/v2/report/{{productView}}
/{{reportApiReferenceId}}
/executeAsync
Parameters:
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to execute ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Request:
Type | Parameters | Example Json | Description |
---|---|---|---|
Required |
| { "recipients" :[], "filtersParameters" : {} } |
For report parameters info click here: Reports REST API - Message Structure |
Additional parameter | Available filters: | { "recipients" :[“address1@mail.com“...], "filtersParameters" : { "deviceNameOp":"eq", "deviceName":"a8a68da7e070", "timeRangeType":"recent", "timeRangePeriod":"600000" } } | TODO - add all available filters and their description. |
Response:
Response Type | Value | Description |
---|---|---|
Successful | { "resultCode": "SUCCESS", "resultMessage": "Report executed successfully", "result": { "executionId": <ID> } } | resultCode → SUCCESS resultMessage → “Report executed successfully” result → executionId → the report execution id (integer). |
GET Get Report Execution Details
URL:
GET - https://{{dpodHostname}}
/op/api/v2/reportexecution/{{productView}}
/{{executionId}}
Request - None.
Parameters:
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Relevant product view APIC / IDG | path | APIC / IDG |
executionId | required | The report execution ID (can be retrieved from “execute report” api response) | path | ID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful | { "resultCode": "SUCCESS", "resultMessage": "Report execution retrieved successfully", "result": { "executionId": 7, "recipients": "", "filters": "", "executingUserName": "admin", "status": "OK", "requestTimeInMillis": 1646827094043, "executionTimeInMillis": 1646827094948, "completionTimeInMillis": 1646827101507 } } | resultCode → SUCCESS resultMessage → “Report execution retrieved successfully” result →
|
========
POST Duplicate R
- No labels