Get / Update / Execute / Delete reports
...
| Code Block |
|---|
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}} |
Retrieve All Reports| Expand |
|---|
| title | /op/api/v2/reports/{{productView}} |
|---|
|
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 |
...
...
URL Parameters
...
productView: IDG / APIC
...
:Authentication Type | Required Permissions | More info |
|---|
Basic Auth | View or Edit report Access permissions for required product
| See roles information here: Role Based Access Control |
Response:Response Type | Value | Description |
|---|
Successful | | 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",....],
"filtersParameters": { "timeRangeType": " |
|
|
...
...
...
...
lastUpdateTimeInMillis": 1646655197926,
|
|
|
...
...
...
"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 Specific Report Details| Expand |
|---|
| title | /op/api/v2/report/{{productView}}/{{reportApiReferenceId}} |
|---|
|
URL:GET - https://{{dpodHostname}}/op/api/v2/reports/{{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 | View or Edit report Access permissions for required product related to the report
| See roles information here: Role Based Access Control |
Response:Response Type | Value | Description |
|---|
Successful | | Code Block |
|---|
{
"resultCode": "SUCCESS",
"resultMessage": "Report retrieved |
|
|
...
successfully",
"result": {
"name": "API Latency |
|
|
...
Report",
"description": "API Latency",
"productView": "APIC |
|
|
...
",
"apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856",
|
|
|
...
...
...
...
...
...
"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }",
|
|
|
...
...
...
...
...
...
TIME", "DEVICE",....],
"filtersParameters": { |
|
|
...
"timeRangeType": "recent",.....},
"lastUpdateTimeInMillis": |
|
|
...
...
...
...
...
"esHeadersDictionary": "" |
|
|
...
...
...
...
...
...
...
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| Expand |
|---|
| title | /op/api/v2/reports/{{productView}} |
|---|
|
URL:GET - https://{{dpodHostname}}/op/api/v2/reports/{{productView}} 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 | View or Edit report Access permissions for required product
| See roles information here: Role Based Access Control |
Response:Response Type | Value | Description |
|---|
Successful | | 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",....],
"filtersParameters": { "timeRangeType": "recent",.....},
"lastUpdateTimeInMillis": 1646655197926,
"lastUpdateUserName": "admin",
"esHeadersDictionary": ""
}
]
}
} |
| resultCode → SUCCESS resultMessage → “Reports retrived successfully” result → list of all reports and their data, for report parameter info click here click here:Reports REST API - Message Structure |
|