Create Charge Back Report

Create Charge Back Report
Generate (create) a Tenant Report using the specified Report Definition and for the specified Resource

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

Request
URI
POST
https://{api_host}/suite-api/api/chargeback/reports
COPY
Request Body

The Tenant Report that needs to be generated

report of type(s) application/json
Required

Show optional properties

{
    "reportDefinitionId": "string",
    "resourceId": "string"
}
"{\n  \"resourceId\" : \"be82d29c-d82d-4d8c-8d9b-7f69d45b1c5f\",\n  \"reportDefinitionId\" : \"97417a6d-708d-4b12-9142-484b5a0df4dc\",\n  \"traversalSpec\" : {\n    \"name\" : \"Traversal spec name\",\n    \"rootAdapterKindKey\" : \"VMWARE\",\n    \"rootResourceKindKey\" : \"VM\",\n    \"adapterInstanceAssociation\" : false\n  },\n  \"subject\" : [ ],\n  \"publish\" : false\n}"
string
completionTime
Optional

Time when the Report Generation completed.

string
description
Optional

Description of the Report.

string
id
Optional

Identifier of the Report.

array of object
links
Optional

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

string
name
Optional

Name of the Report.

string
owner
Optional

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

boolean
publish
Optional

Whether the tenant report needs to be published for tenants.

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.

object
traversalSpec
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

The Generated Tenant 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  \"publish\" : false\n}"
string
completionTime
Optional

Time when the Report Generation completed.

string
description
Optional

Description of the Report.

string
id
Optional

Identifier of the Report.

array of object
links
Optional

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

string
name
Optional

Name of the Report.

string
owner
Optional

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

boolean
publish
Optional

Whether the tenant report needs to be published for tenants.

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.

object
traversalSpec
Optional

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


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/chargeback/reports
On This Page
Tenant Reports Operations
GET
Get Report Schedules By Id
POST
Create Report Schedule By Id
PUT
Update Report Schedule By Id
DELETE
Delete Schedule By Id
GET
Get Report Schedule By Id
GET
Get Charge Back Reports
POST
Create Charge Back Report
DELETE
Delete Charge Back Report
GET
Get Charge Back Report
GET
Download Charge Back Report