Harness

Cloud Cost Perspective Reports

Manage cost reports created on Perspectives.

Fetch details of a cost Report

Fetch cost Report details for the given Report ID or a Perspective ID.

Securityx-api-key
Request
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

query Parameters
perspectiveId
string

Unique identifier for the Perspective

reportId
string

Unique identifier for the Report

Responses
400

Bad Request

500

Internal server error

default

Returns a list of Report Schedules

get/ccm/api/perspectiveReport/{accountIdentifier}
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update a cost Perspective Report
Update cost Perspective Reports.


Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
CEReportSchedule object to be updated


uuid
string
 
name
required
string  [ 1 .. 80 ] characters 
 
enabled
boolean
 
description
string  [ 0 .. 100 ] characters 
 
viewsId
required
Array of strings  = 1 items 
 
userCron
required
string
 
recipients
required
Array of strings  [ 0 .. 50 ] items 
 
accountId
string
 
Array of objects (QLCEViewGroupBy) 
 
Array of objects (QLCEViewFilterWrapper) 
 
object (ViewTimeRange) 
The time interval on which you want to create a Perspective


 
dataColumns
Array of strings
 
exportRowsUpTo
integer <int64> 
 
excludeRowsWithCostBelow
number <double> 
 
createdAt
integer <int64> 
 
lastUpdatedAt
integer <int64> 
 
userCronTimeZone
string
 
object (EmbeddedUser) 
 
object (EmbeddedUser) 
 
nextExecution
string <date-time> 
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a list of Report Schedules


put/ccm/api/perspectiveReport/{accountIdentifier}
Request samples 
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "enabled": true,
  • "description": "string",
  • "viewsId": [
    ],
  • "userCron": "string",
  • "recipients": [
    ],
  • "accountId": "string",
  • "groupBy": [
    ],
  • "filters": [
    ],
  • "viewTimeRange": {
    },
  • "dataColumns": [
    ],
  • "exportRowsUpTo": 0,
  • "excludeRowsWithCostBelow": 0,
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "userCronTimeZone": "string",
  • "createdBy": {
    },
  • "lastUpdatedBy": {
    },
  • "nextExecution": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Create a schedule for a Report
Create a report schedule for the given Report ID or a Perspective ID.


Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
CEReportSchedule object to be saved


uuid
string
 
name
required
string  [ 1 .. 80 ] characters 
 
enabled
boolean
 
description
string  [ 0 .. 100 ] characters 
 
viewsId
required
Array of strings  = 1 items 
 
userCron
required
string
 
recipients
required
Array of strings  [ 0 .. 50 ] items 
 
accountId
string
 
Array of objects (QLCEViewGroupBy) 
 
Array of objects (QLCEViewFilterWrapper) 
 
object (ViewTimeRange) 
The time interval on which you want to create a Perspective


 
dataColumns
Array of strings
 
exportRowsUpTo
integer <int64> 
 
excludeRowsWithCostBelow
number <double> 
 
createdAt
integer <int64> 
 
lastUpdatedAt
integer <int64> 
 
userCronTimeZone
string
 
object (EmbeddedUser) 
 
object (EmbeddedUser) 
 
nextExecution
string <date-time> 
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a list of Report Schedules


post/ccm/api/perspectiveReport/{accountIdentifier}
Request samples 
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "enabled": true,
  • "description": "string",
  • "viewsId": [
    ],
  • "userCron": "string",
  • "recipients": [
    ],
  • "accountId": "string",
  • "groupBy": [
    ],
  • "filters": [
    ],
  • "viewTimeRange": {
    },
  • "dataColumns": [
    ],
  • "exportRowsUpTo": 0,
  • "excludeRowsWithCostBelow": 0,
  • "createdAt": 0,
  • "lastUpdatedAt": 0,
  • "userCronTimeZone": "string",
  • "createdBy": {
    },
  • "lastUpdatedBy": {
    },
  • "nextExecution": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Delete cost Perspective report
Delete cost Perspective Report for the given Report ID or a Perspective ID.


Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
query Parameters
reportId
string
Unique identifier for the Report


 
perspectiveId
string
Unique identifier for the Perspective


 
Responses 
400
Bad Request


500
Internal server error


default
Returns a generic string message when the operation is successful


delete/ccm/api/perspectiveReport/{accountIdentifier}
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Fetch cost Report details accessible to a user
Fetch cost Report details accessible to a user.


Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
Filters for perspective reports


perspectiveIds
Array of strings
Perspective Ids


 
searchText
string
The search text entered to filter out reports by name


 
offset
integer <int32> 
Query Offset


 
limit
integer <int32> 
Query Limit


 
Responses 
400
Bad Request


500
Internal server error


default
Returns a list of Report Schedules


post/ccm/api/perspectiveReport/getAllReports
Request samples 
application/json
{
  • "perspectiveIds": [
    ],
  • "searchText": "string",
  • "offset": 0,
  • "limit": 0
}
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to Cloud Cost Perspectives