Page Comparison

...

Expand

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

URL:

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

Request - None.

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Typeoptions

productView

requiredTrue

Product view APIC / IDG

pathString

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

ValueExample 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": ""
            },
            {....}
        ]
    }
}

Status code: 200

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

Status
colour Green
title GET
Get Specific Report Details

Expand

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

URL:

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

Request - None.

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Typeoptions

productView

requiredTrue

Product view APIC / IDG

pathString

APIC

/

IDG

reportApiReferenceId

requiredTrue

The report apiReferenceId (can be retrieved from “Retrieved all reports” response)

pathString

UUID (generated by default)
String chosen by user in edit/create report

Authorization:

Basic Auth

Authentication Type	Required Permissions	More info
View or Edit report Access permissions for required product related to the report	See roles information here: Role Based Access Control

Response:

Response Type

ValueExample value

Description

Successful

Code Block

language	json

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

Status code: 200

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
Execute (Async) Report

Expand

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

URL:

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

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Typeoptions

productView

requiredTrue

Product view APIC / IDG

pathString

APIC

/

IDG

reportApiReferenceId

requiredTrue

The report apiReferenceId you wish to execute ( id can be retrieved from “Retrieved all reports” response)

pathString

UUID (generated by default)
String chosen by user in edit/create report

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

Request body:

Type

Parameters

Example Json

Description

Required

List<String> recipients
Map<String, String>filtersParameters

Code Block

language	json

{
    "recipients" :[], 
    "filtersParameters" : {}
}

recipients → recipientsRecipients' email address. Array can be sent empty.
filtersParameters→ list List of filters. List can be sent empty.

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

. List can be sent empty.

Additional parameter

Available filters:

Code Block

language	json

{
    "recipients" :[“address1@mail.com“...],
    "filtersParameters" : {
      "deviceNameOp":"eq", 
      "deviceName":"a8a68da7e070<device name>", 
      "timeRangeType":"recent",
      "timeRangePeriod":"600000" 
    }
}

TODO - add all available filters and their description

deviceNameOp→
1. “eq” for equal
2. “ne” for unequitable
filtersParameters→ List of filters. List can be sent empty.

Response:

Response Type

ValueExample value

Description

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "Report executed successfully",
    "result": {
        "executionId": <ID>
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Report executed successfully”

result → executionId → the The report execution id (integer).

...

Expand

title	/op/api/v2/reportexecution/{{productView}}/{{executionId}}

URL:

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

Request - None.

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Typeoptions

productView

requiredTrue

Relevant product view APIC / IDG

pathString

APIC

/

IDG

executionId

requiredTrue

The report execution ID (can be retrieved from “execute report” api response)

pathStringID

The report Id

Authorization:

Basic Auth

Authentication Type	Required Permissions	More info
View or Edit report Access permissions for required product related to the report	See roles information here: Role Based Access Control

Response:

Response Type

ValueExample value

Description

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "Report execution retrieved successfully",
    "result": {
        "executionId": 7,
        "recipients": "",
        "filters": "",
        "executingUserName": "admin",
        "status": "OK",
        "requestTimeInMillis": 1646827094043,
        "executionTimeInMillis": 1646827094948,
        "completionTimeInMillis": 1646827101507
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Report execution retrieved successfully”

result →

executionId→ The report execution ID
recipients→ filters→ Recipients' email address. Array can be sent empty.
filters→ List of filters. List can be sent empty.
executingUserName→ The user who executed this report execution
status→ Report execution status
requestTimeInMillis→ Request time in Millis
executionTimeInMillis→ Execution time in Millis
completionTimeInMillis→ Completion time in Millis

Status
colour Green
title GET
Download Report Execution

Expand

title	/op/api/v2/reportexecution/{{productView}}/{{executionId}}/download

URL:

GET - https://`{{dpodHostname}}`/op/api/v2/reportexecution/`{{productView}}`/`{{executionId}}`/download

Request - None.

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Typeoptions

productView

requiredTrue

Relevant product view APIC / IDG

pathString

APIC

/

IDG

executionId

requiredTrue

The report execution ID (can be retrieved from “execute report” api response)

pathStringID

The report Id

Authorization:

Authentication Type

Basic Auth
Required Permissions
More info
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	xls file type	Status code: 200

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.

URL Parameters:

ParameterName

ValueIs Required

Description

Parameter Type

Data Type

productView

requiredTrue

Product view APIC / IDG

pathString

APIC

/

IDG

reportApiReferenceId

requiredTrue

The report apiReferenceId you wish to duplicate ( id can be retrieved from “Retrieved all reports” response)

path

UUIDString

‘apiReferenceId’ value from the original report

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

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

Status code: 200

resultCode → SUCCESS

resultMessage → “Report duplicated successfully”

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

resultMessage → “Report duplicated successfully”

Status
colour Yellow
title POST
Add Report

Expand

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

URL:

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

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Type

productView

requiredTrue

Product view APIC / IDG

pathString

APIC

/

IDG

Authorization:

Authentication Type	Required Permissions	More info
Basic Auth	Edit report Access permissions for product view of new report	See roles information here: Role Based Access Control

Request body:

Type

Parameters

Example Json

Description

Required

String name
String description
String productView
String indexSets
String documentType
String jsonQuery
String jsonParameters
String schedule
List<String>recipients
List<String>adHocFilterTypes
Map<String, String>filtersParameters
String serviceNameFieldOverride
String esHeadersDictionary

Code Block

language	json

{
        "name": "<new report name>",
        "description": "<new report description>",
        "productView": "<new report productView type>",
        "indexSets": "<new report indexSet>",
        "documentType": "<new report documentType>",
        "jsonQuery": "<new report query>",
        "schedule": "",
        "recipients": [],
        "adHocFilterTypes": [...],
        "filtersParameters": {...},
        "esHeadersDictionary": ""
    }

recipients → recipients' email address. Array can be sent empty.
filtersParameters→ list of filters. List can be sent empty.

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

Additional parameter

Available adHocFilterTypes:

Code Block

language	json

{
      ....
        "adHocFilterTypes": [
            "TIME",
            "DEVICE",
            "DOMAIN",
            "APIC_CATALOG",
            "APIC_SPACE",
            "APIC_PRODUCT",
            "APIC_PLAN",
            "APIC_API",
            "APIC_API_VERSION",
            "APIC_CONSUMER_APP"
        ],
      ....
}

TODO - add all available filters and their description.

Additional parameter

Available filtersParameters:

Code Block

language	json

{
      ....
        "filtersParameters": {
            "timeRangeType": "recent",
            "timeRangePeriod": "86400000"
        },
      ....
}

TODO - add all available filters and their description.

Response:

Response Type

ValueExample value

Description

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "Report added successfully",
    "result": {
         "name": "<new report name>",
        "description": "<new report description>",
        "productView": "<new report productView>",
        "apiReference": "<New unique report uuid>",
        "indexSets": "<new report indexSet>",
        "documentType": "<new report documentType>",
        "jsonQuery": "<new report query>",
        "schedule": "",
        "recipients": [],
        "adHocFilterTypes": ["TIME", "DEVICE",....],
        "filtersParameters": { "timeRangeType": "recent",.....},
        "lastUpdateTimeInMillis": 1646826210928,
        "lastUpdateUserName": "<current userName>",
        "esHeadersDictionary": ""
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Report added successfully”result → The report data. For report parameters info click here:Reports REST API - Message Structure

Status
colour Blue
title PUT
Edit Report

Expand

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

URL:

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

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Type

productView

requiredTrue

Product view APIC / IDG

pathString

APIC

/

IDG

reportApiReferenceId

requiredTrue

The report apiReferenceId you wish to edit ( id can be retrieved from “Retrieved all reports” response)

path

UUIDString

‘apiReferenceId’ of the report you want to edit

Authorization:

Authentication Type	Required Permissions	More info
Basic Auth	Edit report Access permissions for product view of the report	See roles information here: Role Based Access Control

Request:

Type

Parameters

Example Json

Description

Required

String name
String description
String productView
String indexSets
String documentType
String jsonQuery
String jsonParameters
String schedule
List<String>recipients
List<String>adHocFilterTypes
Map<String, String>filtersParameters
String serviceNameFieldOverride
String esHeadersDictionary

Code Block

language	json

{
        "name": "<report edited/source name>",
        "description": "<report edited/source description>",
        "productView": "<report edited/source productView>",
        "indexSets": "<report edited/source indexSet>",
        "documentType": "<report edited/source documentType>",
        "jsonQuery": "<report edited/source query>",
        "schedule": "",
        "recipients": [],
        "adHocFilterTypes": [...],
        "filtersParameters": {...},
        "esHeadersDictionary": ""
    }

recipients → recipients' email address. Array can be sent empty.
filtersParameters→ list of filters. List can be sent empty.

For report parameters info click here:Reports REST API - Message Structure Additional parameter

Available adHocFilterTypes:

Code Block

language	json

{
      ....
        "adHocFilterTypes": [
            "TIME",
            "DEVICE",
            "DOMAIN",
            "APIC_CATALOG",
            "APIC_SPACE",
            "APIC_PRODUCT",
            "APIC_PLAN",
            "APIC_API",
            "APIC_API_VERSION",
            "APIC_CONSUMER_APP"
        ],
      ....
}

TODO - add all available filters and their description.

Additional parameter

Available filtersParameters:

Code Block

language	json

{
      ....
        "filtersParameters": {
            "timeRangeType": "recent",
            "timeRangePeriod": "86400000"
        },
      ....
}

TODO - add all available filters and their description.

Response:

Response Type

ValueExample value

Description

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "Report updated successfully",
    "result": {
         "name": "<report edited/source name>",
        "description": "<report edited/source description>",
        "productView": "<report edited/source productView>",
        "apiReference": "<report uuid>",
        "indexSets": "<report edited/source indexSet>",
        "documentType": "<report edited/source documentType>",
        "jsonQuery": "<report edited/source query>",
        "schedule": "",
        "recipients": [],
        "adHocFilterTypes": ["TIME", "DEVICE",....],
        "filtersParameters": { "timeRangeType": "recent",.....},
        "lastUpdateTimeInMillis": 1646826210928,
        "lastUpdateUserName": "<current userName>",
        "esHeadersDictionary": ""
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Report updated successfully”result → The report data. For report parameters info click here:Reports REST API - Message Structure

Status
colour Red
title DELETE
Delete Report

Expand

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

URL:

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

Request - None.

URL Parameters:

ParameterName

ValueIs required

Description

Parameter Type

Data Type

productView

requiredTrue

Product view APIC / IDG

pathString

APIC

/

IDG

reportApiReferenceId

requiredTrue

The report apiReferenceId you wish to delete ( id can be retrieved from “Retrieved all reports” response)

path

UUIDString

‘apiReferenceId’ of the report to delete

Authorization:

Authentication Type	Required Permissions	More info
Basic Auth	Edit report Access permissions for required product related to the report you wish to delete	See roles information here: Role Based Access Control

Response:

Response Type

ValueExample value

Description

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "Report deleted successfully"
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Report deleted successfully”

...

Page Comparison

Versions Compared

Old Version 29

New Version 30

Key

URL:

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

Request - None.

URL Parameters:

Authorization:

Required PermissionsMore infoBasic AuthView or Edit reportAccess permissions for required productSee roles information here: Role Based Access Control

Response:

StatuscolourGreentitleGET Get Specific Report Details

URL:

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

Request - None.

URL Parameters:

Authorization:

Response:

StatuscolourYellowtitlePOST Execute (Async) Report

URL:

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

URL Parameters:

Authorization:

Required PermissionsMore infoBasic AuthView or Edit reportAccess permissions for required product related to the reportSee roles information here: Role Based Access Control

Request body:

Response:

URL:

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

Request - None.

URL Parameters:

Authorization:

Response:

StatuscolourGreentitleGET Download Report Execution

URL:

GET - https://{{dpodHostname}}/op/api/v2/reportexecution/{{productView}}/{{executionId}}/download

Request - None.

URL Parameters:

Authorization:

Basic AuthRequired PermissionsMore infoView or Edit reportAccess permissions for required product related to the reportSee roles information here: Role Based Access Control

Response:

StatuscolourYellowtitlePOST Duplicate Report

URL:

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

Request - None.

URL Parameters:

Authorization:

Response:

StatuscolourYellowtitlePOST Add Report

URL:

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

URL Parameters:

Authorization:

Request body:

Response:

StatuscolourBluetitlePUT Edit Report

URL:

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

URL Parameters:

Authorization:

Request:

Response:

StatuscolourRedtitleDELETE Delete Report

URL:

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

Request - None.

URL Parameters:

Authorization:

Response:

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

Required Permissions
More info
Basic Auth
View or Edit report
Access permissions for required product
See roles information here: Role Based Access Control

Status
colour Green
title GET
Get Specific Report Details

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

Status
colour Yellow
title POST
Execute (Async) Report

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

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

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

Status
colour Green
title GET
Download Report Execution

GET - https://`{{dpodHostname}}`/op/api/v2/reportexecution/`{{productView}}`/`{{executionId}}`/download

Basic Auth
Required Permissions
More info
View or Edit report
Access permissions for required product related to the report
See roles information here: Role Based Access Control

Status
colour Yellow
title POST
Duplicate Report

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

Status
colour Yellow
title POST
Add Report

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

Status
colour Blue
title PUT
Edit Report

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

Status
colour Red
title DELETE
Delete Report

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