Versions Compared

Old Version 11

changes.mady.by.user Meytal Ben-Tzvi

Saved on

compared with

New Version 12

changes.mady.by.user Meytal Ben-Tzvi

Saved on

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 Blockcurl -u username: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}}

...

Expand
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

  1. View or Edit report

  2. Access permissions for required product

See roles information here: Role Based Access Control

Response:

Response Type

Value

Description

Successful

Code Block
languagejson
{
    "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”

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

...

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

URL:

GET - https://{{dpodHostname}}/op/api/v2/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

  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

Successful

Code Block
languagejson
{
    "resultCode": "SUCCESS",
    "resultMessage": "Report retrieved successfully",
    "result": {
        "name": "API<report Latency Reportname>",
        "description": "API<report Latencydescription>",
        "productView": "APIC<report product view>",
        "apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856<report uuid>",
        "indexSets": "apic-log<report indexSet>",
        "documentType": "APIC_LOGICAL_TRANS<report documentType>",
        "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

...

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

  1. Edit report

  2. 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
languagejson
{
    "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

...

Structure

Status
colourYellow
titlePOST

...

Execute (Async) Report

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

URL:

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

duplicate

executeAsync

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 execute ( id can be retrieved from “Retrieved all reports” response)

path

UUID

Authorization:

Authentication Type

Required Permissions

More info

Basic Auth

  1. View or Edit report

  2. Access permissions for required product related to the report you wish to duplicate

See roles information here: Role Based Access Control

Response

Request:

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

Required

Response Type

ParametersValue

Example Json

Description

Successful

Code Block
languagejson

  1. List<String> recipients

  2. Map<String, String>filtersParameters

Code Block
languagejson
{
        "namerecipients": "<source report name> Copy",
        "description": "<source report description>",
 :[], 
     "productViewfiltersParameters" : "<source report productView>",
   {}
}

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

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

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

Additional parameter

Available filters:

Code Block
languagejson
{
    "apiReferencerecipients": "<New unique report uuid>",
 :[“address1@mail.com“...],
       "indexSets": "<source report indexSet>",
        "documentType": "<source report documentType>",
"filtersParameters" : {
         "jsonQuerydeviceNameOp": "<source report query>eq", 
       "scheduledeviceName": "a8a68da7e070",
 
      "recipientstimeRangeType": []"recent",
        "adHocFilterTypestimeRangePeriod": ["TIME600000", "DEVICE",....],
    }
}

TODO - add all available filters and their description.

Response:

Response Type

Value

Description

Successful

Code Block
languagejson
{
"filtersParameters":
{
 "
timeRangeType
resultCode": "
recent
SUCCESS",
.....}, 

    
"
lastUpdateTimeInMillis
resultMessage":
1646826210928,
"Report executed 
successfully",
    "
lastUpdateUserName
result":
"<current
{
userName>",
        
"
esHeadersDictionary
executionId":
""
<ID>
    }
}

resultCode → SUCCESS

resultMessage → “Report

duplicated

executed successfully”

result → executionId →

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

the report execution id

========