Get Reports Using GET | VMware vRealize Operations API

Get Reports Using GET

If the query spec is not provided, all Reports present in the system are returned.

Request

URI

GET

https://{api_host}/api/reports

COPY

Query Parameters

string of array

name

Optional

Reports name with which the filtering can be done

object of array

others

Optional

others

string of array

resourceId

Optional

Resources on which the reports are generated

string of array

status

Optional

Status of the report

string of array

subject

Optional

Subjects with which the filtering can be done

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The Collection of Reports matching the specified search critiera

Returns reports of type(s) application/json

{
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    },
    "reports": [
        {
            "completionTime": "string",
            "description": "string",
            "id": "string",
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "name": "string",
            "owner": "string",
            "reportDefinitionId": "string",
            "resourceId": "string",
            "status": "string",
            "subject": [
                "string"
            ],
            "traversalSpec": {
                "adapterInstanceAssociation": false,
                "description": "string",
                "name": "string",
                "rootAdapterKindKey": "string",
                "rootResourceKindKey": "string"
            }
        }
    ]
}

array of link

links

Optional

Collection of links

page-info

pageInfo

Optional

Represents page information for a paged result

array of report

reports

Optional

Collection of reports