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 | ||||
---|---|---|---|---|
|
...
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
...
language | json |
---|
...
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 | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
URL:GET - https:// |
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 |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| 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 | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:GET - https:// |
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 |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description | ||||
---|---|---|---|---|---|---|
Successful |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| resultCode → SUCCESS resultMessage → |
“Report retrieved successfully” result → |
The report data. For report parameters info click here:Reports REST API - Message Structure |
Status | |
---|---|
|
...
|
...
|
...
Duplicate Report
...
Expand | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
URL:GETPOST - https:// |
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 |
| See roles information here: Role Based Access Control |
Response:
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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
resultCode → SUCCESS
resultMessage → “Report retrieved successfully”
result → The report data. For report parameters info click here:Reports REST API - Message StructureStatus | ||||
---|---|---|---|---|
|
|
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - https:// |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to execute ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Request:
Type | Parameters | Example Json | Description | ||||
---|---|---|---|---|---|---|---|
Required |
|
|
|
|
For report parameters info click here:Reports REST API - Message Structure | ||||||
Additional parameter | Available filters: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| TODO - add all available filters and their description. |
Response:
Response Type | Value | Description | ||||
---|---|---|---|---|---|---|
Successful |
|
|
|
|
|
|
|
|
|
|
|
|
| resultCode → SUCCESS resultMessage → “Report |
executed successfully” result → executionId → |
the report execution id (integer). |
Status | |
---|---|
|
...
|
...
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
URL:POSTGET - https://report |
Parameter | Value |
---|
Description
Parameter Type
Data Type
productView
required
Product view APIC / IDG
path
APIC / IDG
reportApiReferenceId
required
The report apiReferenceId you wish to execute ( id 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
Request:
Type
Parameters
Example Json
Description
Required
List<String>
recipients
Map<String, String>
filtersParameters
Code Block | ||
---|---|---|
| ||
{
"recipients" :[],
"filtersParameters" : {}
} |
recipients
→ recipients' email address. Array can be sent empty.filtersParameters
→ list of filters. List can be sent empty.
Additional parameter
Description | Parameter Type | Data Type | ||
---|---|---|---|---|
productView | required | Relevant product view APIC / IDG | path | APIC / IDG |
executionId | required | The report execution ID (can be retrieved from “execute report” api response) | path | ID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description | ||||
---|---|---|---|---|---|---|
Successful |
|
|
|
|
|
|
|
|
|
|
|
|
TODO - add all available filters and their description.
Response:
Response Type
Value
Description
Successful
language | json |
---|
|
|
|
|
|
|
|
|
| resultCode → SUCCESS resultMessage → “Report |
execution retrieved successfully” result →
|
|
========
Status | ||||
---|---|---|---|---|
|