Working with the Chargeback Hierarchy API

This topic describes how can you can perform the following operations on Chargeback Hierarchies using Chargeback Hierarchy HTTP methods provided by the Chargeback API.

CREATE a hierarchy (using the POST method)
RETRIEVE a hierarchy (using the GET and POST methods)
UPDATE a hierarchy (using the PUT and POST methods)
DELETE a hierarchy (using the DELETEmethod)

To create a hierarchy

You can use the POSTHTTP method to create, instantiate and search targets through the Chargeback API. There are various methods in the Chargeback API library that allow you to do so.

Instantiate a new instance of a hierarchy
Set the root target for the hierarchy based on hierarchy ID
Append a target node under the target parent specified

To instantiate a new instance of a hierarchy

To set the root target for the hierarchy based on hierarchy ID

The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

To append a target node under the target parent specified

To retrieve a hierarchy

You can use the GETHTTP method to retrieve Chargeback hierarchies through the Chargeback API. There are various methods in the Chargeback API library that allow you to do so.

Retrieve the hierarchical structure of the target by ID
Retrieve a hierarchy based on hierarchy ID
Search all instances of a hierarchy
Search the target structure in the hierarchy specified

To retrieve the hierarchical structure of the target by ID

To retrieve a hierarchy based on hierarchy ID

To search all instances of a hierarchy

To search the target structure in the hierarchy specified

To update a hierarchy

You can use the PUTHTTP method to update or modify Chargeback hierarchies through the Chargeback API. There are various methods in the Chargeback API library that allow you to do so.

Modify hierarchy data based on hierarchy ID
Move an existing target node under the new target parent specified

To modify hierarchy data based on hierarchy ID

To move an existing target node under the new target parent specified

To delete a hierarchy

You can use the DELETEHTTP method to delete or remove Chargeback hierarchies through the Chargeback API. There are various methods in the Chargeback API library that allow you to do so.