Create Report Using POST

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

{
    "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"
    }
}

string

completionTime

Optional

Time when the Report Generation completed.

string

description

Optional

Description of the Report.

string

Optional

Identifier of the Report.

array of link

links

Optional

links

string

name

Optional

Name of the Report.

string

owner

Optional

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

string As uuid As uuid

reportDefinitionId

Required

Identifier of the Report Definition used to generate this Report.

string As uuid As uuid

resourceId

Required

Resource identifier for which the Report needs to be generated.

string

status

Optional

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

array of string

subject

Optional

Subjects of the Report.

traversal-spec

traversalSpec

Optional

traversalSpec

Authentication

This operation uses the following authentication methods.

CSPToken

Responses

200

The Generated Report

Returns report of type(s) application/json

{
    "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"
    }
}

string

completionTime

Optional

Time when the Report Generation completed.

string

description

Optional

Description of the Report.

string

Optional

Identifier of the Report.

array of link