Table 12. API Resources for Hierarchies
|
|
Additional Input Parameters |
|
GET |
/hierarchies |
None |
Returns a list of hierarchies that the current user can access. |
GET |
/hierarchies/billing |
None |
Returns a list of billing hierarchies, including IDs and names, that the current user can access. |
GET |
/hierarchies/business |
None |
Returns a list of business hierarchies, including hierarchy IDs and names, that the current user can access. |
GET |
/hierarchies/type/{hierarchy_type} |
None |
Returns a list of hierarchies by hierarchy type, that the current user can access. |
GET |
/hierarchies/{hierarchy_id}/my_root_nodes |
period (Optional) |
Returns the list of root nodes of the hierarchy that the current user can access, for the latest period. You can optionally specify a different period. |
GET |
/hierarchies/{hierarchy_id}/linktarget_type/ |
None |
Returns a list of valid link target types for a hierarchy. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/accounts |
None |
Returns a list of accounts for the hierarchy that the current user can access, and an index. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/service_agreements |
None |
Returns a list of service agreements for the hierarchy that the current user can access. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/groups |
None |
Returns a list of groups for the hierarchy that the current user can access. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/children |
None |
Returns a list of child nodes for a particular node, and a node index. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/{linktarget_type} |
None |
Returns a list of link targets for a particular node. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/users/assigned |
None |
Returns a list of users assigned to a node. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/users/unassigned |
None |
Returns a list of users unassigned to a node. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/users/authorized |
None |
Returns a list of users authorized for this node. |
GET |
/hierarchies/{hierarchy_id}/{node_id}/users/unauthorized |
None |
Returns a list of users unauthorized for this node. |
GET |
/hierarchies/{hierarchy_id}/linktarget_node/{linktarget_uri} |
None |
Returns a node ID using the unique link target URI, without the hierarchy node type. |
POST |
/hierarchies/{hierarchy_id}/{node_id}/accounts |
None |
Adds an account to a node as a child node. |
POST |
/hierarchies/{hierarchy_id}/{nodeid}/service_agreements |
None |
Adds a service agreement to a node as a child node. |
POST |
/hierarchies/{hierarchy_id}/{nodeid}/groups |
None |
Adds a group to a node as a child node. |
POST |
/hierarchies/{hierarchy_id}/{nodeid}/{linktarget_type} |
None |
Adds a linktarget node with a particular link target type as a child node. |
POST |
/hierarchies/type/{hierarchy_type} |
None |
Creates a hierarchy for a particular hierarchy type. |
POST |
/hierarchies/{hierarchy_id}/{nodeid}/users/ |
None |
Assigns a user to a node using the user ID from the payload. |