Chargeback API

The TrueSight Capacity Optimization Chargeback API is an object-oriented implementation of the Representational State Transfer API (RESTful API).

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

The RESTful API provides HTTP methods to instance, retrieve, modify and delete a Chargeback object with the help of specific RESTful API URI (Uniform Resource Identifier) patterns.


Before you begin

  • Ensure that you have valid user credentials in Base64-encoded format for the Authorization HTTP header. For more details, see Restful web services authentication.
  • Ensure that your user role has the Enable access to Chargeback API activity (API_CHARGEBACK) assigned to it. For more information about managing roles and activities, see Adding and managing roles.

All methods

Method

URI Pattern

Description

POST

chargeback/{classname}

Create a new instance of a class.

POST

chargeback/{classname}/search

Search all instances of a class.

GET

chargeback/{classname}/{uuid}

Retrieve an object by ID.

PUT

chargeback/{classname}/{uuid}

Update data about an object by ID.

DELETE

chargeback/{classname}/{uuid}

Delete an object by ID.

Chargeback API data type definition file

To download a .xsd data type definition file that contains definitions of all data types used in the Chargeback API, click here.

Where to go from here

Working with Chargeback APIs

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

Comments