/
Reports REST API

IBM DataPower Operations Dashboard v1.0.21.x

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Reports REST API

Owned by Avi Falah
Mar 22, 2022
7 min read

Available report actions via APIs

Get / Create / Update / Execute / Delete reports

Authorization:

Authentication: Basic authentication

Roles: it is recommended to read Role Based Access Control page for understanding build-in and custom roles permissions.

From CLI (example):

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.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Product view APIC / IDG

String

  • APIC

  • IDG

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit report

  2. Access permissions for required product

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

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

Status code: 200

resultCode → SUCCESS

resultMessage → “Reports retrieved successfully”

 

GET Get Specific Report Details

URL:

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

Request - None.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Product view APIC / IDG

String

  • APIC

  • IDG

reportApiReferenceId

True

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

String

  • UUID (generated by default)

  • String chosen by user in edit/create report

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit report

  2. Access permissions for required product related to the report

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

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

Status code: 200

resultCode → SUCCESS

resultMessage → “Report retrieved successfully”

POST Execute (Async) Report

URL:

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

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Product view APIC / IDG

String

  • APIC

  • IDG

reportApiReferenceId

True

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

String

  • UUID (generated by default)

  • String chosen by user in edit/create report

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit report

  2. Access permissions for required product related to the report

See roles information here: Role Based Access Control

Request body:

Type

Parameters

Example Json

Description

Type

Parameters

Example Json

Description

Required

  1. List<String> recipients

  2. Map<String, String>filtersParameters

  1. recipients → Recipients' email address. Array can be sent empty.

  2. filtersParameters→ List of filters. List can be sent empty.

 

Additional parameter

Available filters:

  1. deviceNameOp→

    1. “eq” for equal

    2. “ne” for unequitable

  2. filtersParameters→ List of filters. List can be sent empty.

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

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.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Relevant product view APIC / IDG

String

  • APIC

  • IDG

executionId

True

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

String

The report Id

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit report

  2. Access permissions for required product related to the report

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Report execution retrieved successfully”

result →

  • executionId→ The report execution ID

  • recipients→ 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

GET Download Report Execution

URL:

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

Request - None.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Relevant product view APIC / IDG

String

  • APIC

  • IDG

executionId

True

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

String

The report Id

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit report

  2. Access permissions for required product related to the report

See roles information here: Role Based Access Control

Response:

Response Type

Value

Description

Response Type

Value

Description

Successful

xls file type

Status code: 200

POST Duplicate Report

POST Add Report

PUT Edit Report

DELETE Delete Report

 

 

Related content

Reports REST API
Reports REST API
IBM DPOD v1.0.18.0
More like this
Reports REST API
Reports REST API
IBM DPOD v1.0.19.0
More like this
Reports REST API
Reports REST API
IBM DPOD v1.0.16.0
More like this
Reports REST API
Reports REST API
IBM DPOD v1.0.20.x
More like this
Reports REST API
Reports REST API
IBM DPOD v1.0.17.0
More like this
Reports REST API
Reports REST API
IBM DPOD v1.0.22.x
More like this

Copyright © 2015 MonTier Software (2015) Ltd.