Get / Update / Execute / Delete reports
Authentication: Basic authentication
Authorization: Any user allowed using Reports, see:
Code Block |
---|
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}} |
Retrieve All Reports |
---|
URL | GET https://<dpod hostname>/op/api/v2/reports/{{productView}}
|
Authorization (more info Role Based Access Control) | |
URL Parameters | productView: IDG / APIC |
Successful Response | Code Block |
---|
{
"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",
"DOMAIN",
"APIC_CATALOG",
"APIC_SPACE",
"APIC_PRODUCT",
"APIC_PLAN",
"APIC_API",
"APIC_API_VERSION",
"APIC_CONSUMER_APP"
],
"filtersParameters": {
"timeRangeType": "recent",
"timeRangePeriod": "86400000"
},
"lastUpdateTimeInMillis": 1646655197926,
"lastUpdateUserName": "admin",
"esHeadersDictionary": ""
}
]
}
} |
resultCode: resultMessage: name: description: productView: apiReference: indexSets: documentType: jsonQuery: schedule: recipients: adHocFilterTypes: filtersParameters: lastUpdateTimeInMillis: lastUpdateUserName: esHeadersDictionary: | Erroneous Response | Code Block |
---|
{
"resultCode": "SUCCESS",
"resultMessage": "Reports retrieved successfully",
} |
resultCode: resultMessage:results: list of reports Reports REST API - Message Structure → Response Report |