Chargeback API

The BMC Helix Capacity Optimization Chargeback API is an object-oriented implementation of the Representational State Transfer API (RESTful API). The RESTful API provides HTTP methods to retrieve, modify, or delete a Chargeback object using specific RESTful API URI (Uniform Resource Identifier) patterns.

For information about performing operations on Chargeback models using HTTP method calls provided by the Chargeback API, see Working with Chargeback APIs.

Before you begin

Ensure that the following requirements are met:

All methods

The API supports the following methods:

Method

URI pattern

Description

Required activity

POST

chargeback/{classname}

Create a new instance of a class.

Write access to Chargeback API

POST

chargeback/{classname}/search

Search all instances of a class.

Read access to Chargeback API

GET

chargeback/{classname}/{uuid}

Retrieve an object by ID.

Read access to Chargeback API

PUT

chargeback/{classname}/{uuid}

Update data about an object by ID.

Write access to Chargeback API

DELETE

chargeback/{classname}/{uuid}

Delete an object by ID.

Write access to Chargeback API

Chargeback API data type definition file

To know the data types that are used by the Chargeback API, download the attached file.

Where to go from here

Working with Chargeback APIs

Was this page helpful? Yes No Submitting... Thank you

Comments