Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

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}}

Status
colour Green
title GET
Retrieve All Reports

...

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:

...

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

language	json

{
    "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”

...

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}}

Status
colour Green
title GET

...

Retrieve All Reports

required

Expand

title	/op/api/v2/reportreports/{{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

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

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "

Report

Reports retrieved successfully",
    "result": {
        "

name

reports":

"API Latency Report",

 [{
                "

description

name": "API Latency Report",

"productView": "APIC",

       "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":

1644768927839

1646655197926,

"lastUpdateUserName":

"Installer",

esHeadersDictionary

lastUpdateUserName": "admin",

} }

            "esHeadersDictionary": ""
            }
        ]
    }
}

resultCode → SUCCESS

resultMessage →

“Report

“Reports retrieved successfully”

result →

The report

list of all reports and their data. For report parameters info click here:Reports REST API - Message Structure

Get / Update / Execute / Delete reports

Authentication: Basic authentication

Authorization: Any user allowed using Reports, see:

...

Status
colour Green
title GET
Get Specific Report Details

Expand

title	/op/api/v2/

...

report/{{productView}}/{{reportApiReferenceId}}

Status
colour Green
title GET
Retrieve All Reports

Expand

title	/op/api/v2/reports/{{productView}}

URL:

GET

URL:

GET - https://`{{dpodHostname}}`/op/api/v2/

reports

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	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

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "

Reports

Report retrieved successfully",
    "result": {

"reports": [{

"name": "API Latency Report",
        "description": "API Latency",
        "productView": "APIC",

"name": "API Latency Report", "description": "API Latency", "productView": "APIC", "apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856",

"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": 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

Status
colour Yellow
title POST
Duplicate Report

Expand

title	/op/api/v2/report/{{productView}}/{{reportApiReferenceId}}/duplicate

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	Edit report Access permissions for required product related to the report you wish to duplicate	See roles information here: Role Based Access Control

Response:

Response Type

Value

Description

Successful

Code Block

language	json

{
    "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

========

Status
colour Yellow
title POST
Duplicate Report

Expand

title	/op/api/v2/report/{{productView}}/{{reportApiReferenceId}}/duplicate

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	Edit report Access permissions for required product related to the report you wish to duplicate	See roles information here: Role Based Access Control

Response:

Response Type

Value

Description

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "Report duplicated successfully",
    "result": {
        "

indexSets": "apic-log",

name": "<source report name> Copy",

documentType

description": "

APIC_LOGICAL_TRANS

<source report description>",
        "productView": "<source report productView>",

"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }",

  "apiReference": "<New unique report uuid>",
        "indexSets": "<source report indexSet>",
        "

schedule

documentType": "<source report documentType>",
        "jsonQuery": "<source report query>",
        "

recipients

schedule":

[],

"",
        "recipients": [],

"adHocFilterTypes": ["TIME", "DEVICE",....],

"filtersParameters": { "timeRangeType": "recent",

...

}, "lastUpdateTimeInMillis": 1646655197926, "lastUpdateUserName": "admin"

..},

"esHeadersDictionary

"lastUpdateTimeInMillis":

1646826210928,
        "lastUpdateUserName": "<current userName>",

}

]

"esHeadersDictionary": ""
    }
}

resultCode → SUCCESS

resultMessage →

“Reports retrived

“Report duplicated successfully”

result →

list of all reports and their data, for report parameter info click here

The report data. For report parameters info click here:Reports REST API - Message Structure

========

Page Comparison

Versions Compared

Old Version 9

New Version 10

Key

StatuscolourGreentitleGET Retrieve All Reports

URL:

GET - https://{{dpodHostname}}/op/api/v2/reports/{{productView}}

Request - None.

Parameters:

Authorization:

Response:

StatuscolourGreentitleGET

Retrieve All Reports

URL:

GET - https://{{dpodHostname}}/op/api/v2/reports/{{productView}}

Request - None.

Parameters:

Authorization:

Response:

StatuscolourGreentitleGET Get Specific Report Details

StatuscolourGreentitleGET Retrieve All Reports

URL:

URL:

GET - https://{{dpodHostname}}/op/api/v2/

report/{{productView}}/{{reportApiReferenceId}}

Request - None.

Parameters:

Authorization:

Response:

StatuscolourYellowtitlePOST Duplicate Report

URL:

POST - https://{{dpodHostname}}/op/api/v2/report/{{productView}}/{{reportApiReferenceId}}/duplicate

Request - None.

Parameters:

Authorization:

Response:

StatuscolourYellowtitlePOST Duplicate Report

URL:

POST - https://{{dpodHostname}}/op/api/v2/report/{{productView}}/{{reportApiReferenceId}}/duplicate

Request - None.

Parameters:

Authorization:

Response:

Status
colour Green
title GET
Retrieve All Reports

GET - https://`{{dpodHostname}}`/op/api/v2/reports/`{{productView}}`

Status
colour Green
title GET

GET - https://`{{dpodHostname}}`/op/api/v2/reports/`{{productView}}`

Status
colour Green
title GET
Get Specific Report Details

Status
colour Green
title GET
Retrieve All Reports

GET - https://`{{dpodHostname}}`/op/api/v2/

report/`{{productView}}`/`{{reportApiReferenceId}}`

Status
colour Yellow
title POST
Duplicate Report

POST - https://`{{dpodHostname}}`/op/api/v2/report/`{{productView}}`/`{{reportApiReferenceId}}`/duplicate

Status
colour Yellow
title POST
Duplicate Report

POST - https://`{{dpodHostname}}`/op/api/v2/report/`{{productView}}`/`{{reportApiReferenceId}}`/duplicate