...
Status | ||||
---|---|---|---|---|
|
...
/op/api/v2/reports/{{productView}} | ||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
URL:GET - https:// |
Paste code macro | ||||
---|---|---|---|---|
| ||||
/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 |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| 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 |
...
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 |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report retrieved successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
...
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 |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report executed successfully” result → executionId → the report execution id (integer). |
...
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
URL:GET - https:// |
Parameter | Value | 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 |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report execution retrieved successfully” result →
|
...
Expand | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
URL:GET - https:// |
Parameter | Value | 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 | xls file type | Status code: 200 |
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 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:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report duplicated successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - 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 |
Request:
Type | Parameters | Example Json | Description | |||||
---|---|---|---|---|---|---|---|---|
Required |
|
|
For report parameters info click here:Reports REST API - Message Structure | |||||
Additional parameter | Available |
| TODO - add all available filters and their description. | |||||
Additional parameter | Available |
| TODO - add all available filters and their description. |
Response:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report added successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:PUT - 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 edit ( 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 |
| TODO - add all available filters and their description. | |||||
Additional parameter | Available |
| TODO - add all available filters and their description. |
Response:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report updated successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
...
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
URL:DELETE - 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 delete ( 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:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report deleted successfully” |
...