Create Report | VCF Operations API

Create Report

Generate (create) a Report using the specified Report Definition and for the specified Resource

Request

URI

POST

https://{api_host}/suite-api/api/reports

COPY

Request Body

The Report that needs to be generated

report of type(s) application/json

Required

Show optional properties

{
    "resourceId": "string",
    "reportDefinitionId": "string"
}

"{\n  \"resourceId\" : \"13ca7770-6064-41fd-b7f9-ce0129baa72c\",\n  \"reportDefinitionId\" : \"7046e2a6-0dcf-40ae-8b4b-0d140e5754a8\",\n  \"traversalSpec\" : {\n    \"name\" : \"Traversal spec name\",\n    \"rootAdapterKindKey\" : \"VMWARE\",\n    \"rootResourceKindKey\" : \"VM\",\n    \"adapterInstanceAssociation\" : false\n  },\n  \"subject\" : [ ]\n}"

string

Optional

Identifier of the Report.

string

name

Optional

Name of the Report.

string

description

Optional

Description of the Report.

string As uuid As uuid

resourceId

Required

Resource identifier for which the Report needs to be generated.

string As uuid As uuid

reportDefinitionId

Required

Identifier of the Report Definition used to generate this Report.

object

traversalSpec

Optional

Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.

array of string

subject

Optional

Subjects of the Report.

string

owner

Optional

Owner (user) who created/executed the Report Generation.

string

completionTime

Optional

Time when the Report Generation completed.

string

status

Optional

Status of Report Generation - whether the Report got generated successfully or not.

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The Generated Report

Returns report of type(s) application/json

"{\n  \"description\" : \"Cluster Capacity Risk Forecast Report\",\n  \"subject\" : [ ],\n  \"owner\" : \"admin\",\n  \"completionTime\" : \"1 hour ago\",\n  \"status\" : \"Completed\"\n}"

string

Optional

Identifier of the Report.

string

name

Optional

Name of the Report.

string

description

Optional

Description of the Report.

string As uuid As uuid

resourceId

Required

Resource identifier for which the Report needs to be generated.

string As uuid As uuid

reportDefinitionId

Required

Identifier of the Report Definition used to generate this Report.

object

traversalSpec

Optional

Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.

array of string

subject

Optional

Subjects of the Report.

string

owner

Optional

Owner (user) who created/executed the Report Generation.

string

completionTime

Optional

Time when the Report Generation completed.

string

status

Optional

Status of Report Generation - whether the Report got generated successfully or not.

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"reportDefinitionId:"string","resourceId:"string"}' https://{api_host}/suite-api/api/reports

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Reports Operations

GET

Get Report Schedules

PUT

Update Report Schedule