Package com.seeq.api
Class TreesApi
java.lang.Object
com.seeq.api.TreesApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd the specified items as child nodes of the specified parents within the specified tree.batchMoveNodesToParentsWithHeadersAndHttpInfo
(AssetTreeBatchInputV1 body, Map<String, String> customHeaders) Add the specified items as child nodes of the specified parents within the specified tree.Add the specified items as child nodes of the specified parents within the specified tree.createTree
(AssetGroupInputV1 body) Create or update an asset treecreateTreeWithHeadersAndHttpInfo
(AssetGroupInputV1 body, Map<String, String> customHeaders) Create or update an asset treeCreate or update an asset treegetAllTreeTypes
(Integer offset, Integer limit) Get a collection of all available tree typesgetAllTreeTypesWithHeadersAndHttpInfo
(Integer offset, Integer limit, Map<String, String> customHeaders) Get a collection of all available tree typesgetAllTreeTypesWithHttpInfo
(Integer offset, Integer limit) Get a collection of all available tree typeslong
getTree
(String id, List<String> scope, Integer offset, Integer limit, Boolean includeDescendants, Boolean excludeGloballyScoped) Get the ancestors and children of the specified item within the context of this treegetTreeRootNodes
(List<String> scope, Integer offset, Integer limit, List<String> properties, Boolean excludeGloballyScoped) Get a collection of root nodes for the asset treegetTreeRootNodesWithHeadersAndHttpInfo
(List<String> scope, Integer offset, Integer limit, List<String> properties, Boolean excludeGloballyScoped, Map<String, String> customHeaders) Get a collection of root nodes for the asset treegetTreeRootNodesWithHttpInfo
(List<String> scope, Integer offset, Integer limit, List<String> properties, Boolean excludeGloballyScoped) Get a collection of root nodes for the asset treegetTreeWithHeadersAndHttpInfo
(String id, List<String> scope, Integer offset, Integer limit, Boolean includeDescendants, Boolean excludeGloballyScoped, Map<String, String> customHeaders) Get the ancestors and children of the specified item within the context of this treegetTreeWithHttpInfo
(String id, List<String> scope, Integer offset, Integer limit, Boolean includeDescendants, Boolean excludeGloballyScoped) Get the ancestors and children of the specified item within the context of this treemoveNodesToParent
(String parentId, ItemIdListInputV1 body) Add the specified items as child nodes of the specified parent within the specified tree.moveNodesToParentWithHeadersAndHttpInfo
(String parentId, ItemIdListInputV1 body, Map<String, String> customHeaders) Add the specified items as child nodes of the specified parent within the specified tree.moveNodesToParentWithHttpInfo
(String parentId, ItemIdListInputV1 body) Add the specified items as child nodes of the specified parent within the specified tree.Add the specified items as root nodes of the specified tree.moveNodesToRootOfTreeWithHeadersAndHttpInfo
(ItemIdListInputV1 body, Map<String, String> customHeaders) Add the specified items as root nodes of the specified tree.Add the specified items as root nodes of the specified tree.void
rebuildSearchIndex
(String rootAssetId) Trigger a rebuild of an asset tree search index in the background, starting at the specified root asset.void
rebuildSearchIndexWithHeadersAndHttpInfo
(String rootAssetId, Map<String, String> customHeaders) Trigger a rebuild of an asset tree search index in the background, starting at the specified root asset.void
rebuildSearchIndexWithHttpInfo
(String rootAssetId) Trigger a rebuild of an asset tree search index in the background, starting at the specified root asset.Remove an item and its children from the tree.removeNodeFromTreeWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Remove an item and its children from the tree.Remove an item and its children from the tree.Scale a tree item across its asset tree.scaleAcrossTreeWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Scale a tree item across its asset tree.Scale a tree item across its asset tree.void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) treemap
(String start, String end, List<String> conditionIds, String swapId, String parentId, List<String> parameters, List<String> formulas) Build a treemaptreemapWithHeadersAndHttpInfo
(String start, String end, List<String> conditionIds, String swapId, String parentId, List<String> parameters, List<String> formulas, Map<String, String> customHeaders) Build a treemaptreemapWithHttpInfo
(String start, String end, List<String> conditionIds, String swapId, String parentId, List<String> parameters, List<String> formulas) Build a treemapupdateTree
(AssetGroupInputV1 body) Update an asset treeupdateTreeWithHeadersAndHttpInfo
(AssetGroupInputV1 body, Map<String, String> customHeaders) Update an asset treeUpdate an asset tree
-
Constructor Details
-
TreesApi
public TreesApi() -
TreesApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
batchMoveNodesToParents
Add the specified items as child nodes of the specified parents within the specified tree. If an item is already a member of this tree, it will move from its current parent to the specified parent. The children of the items being moved will move with each parent. When x-sq-async-job header is set to 'true' the operation runs as an async job that may be queried using the Jobs API.- Parameters:
body
- (optional)- Returns:
- ItemBatchOutputV1
- Throws:
ApiException
- if fails to make API call
-
batchMoveNodesToParentsWithHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> batchMoveNodesToParentsWithHttpInfo(AssetTreeBatchInputV1 body) throws ApiException Add the specified items as child nodes of the specified parents within the specified tree. If an item is already a member of this tree, it will move from its current parent to the specified parent. The children of the items being moved will move with each parent. When x-sq-async-job header is set to 'true' the operation runs as an async job that may be queried using the Jobs API.- Parameters:
body
- (optional)- Throws:
ApiException
- if fails to make API call
-
batchMoveNodesToParentsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> batchMoveNodesToParentsWithHeadersAndHttpInfo(AssetTreeBatchInputV1 body, Map<String, String> customHeaders) throws ApiExceptionAdd the specified items as child nodes of the specified parents within the specified tree. If an item is already a member of this tree, it will move from its current parent to the specified parent. The children of the items being moved will move with each parent. When x-sq-async-job header is set to 'true' the operation runs as an async job that may be queried using the Jobs API.- Parameters:
body
- (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createTree
Create or update an asset tree- Parameters:
body
- (optional)- Returns:
- AssetGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
createTreeWithHttpInfo
public ApiClient.ApiResponse<AssetGroupOutputV1> createTreeWithHttpInfo(AssetGroupInputV1 body) throws ApiException Create or update an asset tree- Parameters:
body
- (optional)- Throws:
ApiException
- if fails to make API call
-
createTreeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AssetGroupOutputV1> createTreeWithHeadersAndHttpInfo(AssetGroupInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update an asset tree- Parameters:
body
- (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getAllTreeTypes
Get a collection of all available tree types- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- ItemPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getAllTreeTypesWithHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getAllTreeTypesWithHttpInfo(Integer offset, Integer limit) throws ApiException Get a collection of all available tree types- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getAllTreeTypesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getAllTreeTypesWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of all available tree types- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getTree
public AssetTreeOutputV1 getTree(String id, List<String> scope, Integer offset, Integer limit, Boolean includeDescendants, Boolean excludeGloballyScoped) throws ApiException Get the ancestors and children of the specified item within the context of this tree- Parameters:
id
- ID of the parent asset (required)scope
- The IDs of the workbooks to which the items are scoped<br>If scope is set to the Empty GUID then the scoped items are excluded. (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)includeDescendants
- If the children of the children should be retrieved. Note that a 400 error will be returned if the total number of children and descendants exceeds the specified limit (optional, default to false)excludeGloballyScoped
- Exclude globally scoped items. (optional, default to false)- Returns:
- AssetTreeOutputV1
- Throws:
ApiException
- if fails to make API call
-
getTreeWithHttpInfo
public ApiClient.ApiResponse<AssetTreeOutputV1> getTreeWithHttpInfo(String id, List<String> scope, Integer offset, Integer limit, Boolean includeDescendants, Boolean excludeGloballyScoped) throws ApiException Get the ancestors and children of the specified item within the context of this tree- Parameters:
id
- ID of the parent asset (required)scope
- The IDs of the workbooks to which the items are scoped<br>If scope is set to the Empty GUID then the scoped items are excluded. (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)includeDescendants
- If the children of the children should be retrieved. Note that a 400 error will be returned if the total number of children and descendants exceeds the specified limit (optional, default to false)excludeGloballyScoped
- Exclude globally scoped items. (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
getTreeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AssetTreeOutputV1> getTreeWithHeadersAndHttpInfo(String id, List<String> scope, Integer offset, Integer limit, Boolean includeDescendants, Boolean excludeGloballyScoped, Map<String, String> customHeaders) throws ApiExceptionGet the ancestors and children of the specified item within the context of this tree- Parameters:
id
- ID of the parent asset (required)scope
- The IDs of the workbooks to which the items are scoped<br>If scope is set to the Empty GUID then the scoped items are excluded. (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)includeDescendants
- If the children of the children should be retrieved. Note that a 400 error will be returned if the total number of children and descendants exceeds the specified limit (optional, default to false)excludeGloballyScoped
- Exclude globally scoped items. (optional, default to false)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getTreeRootNodes
public AssetTreeOutputV1 getTreeRootNodes(List<String> scope, Integer offset, Integer limit, List<String> properties, Boolean excludeGloballyScoped) throws ApiException Get a collection of root nodes for the asset tree- Parameters:
scope
- The IDs of the workbooks to which the items are scoped<br>If the scope is set to the Empty GUID, then the scoped items are excluded. (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)properties
- A list of property names and values to filter on. Arguments should be passed in in the following format Property=Value, with each new property-value pair on a new line. The option to filter out a node by a property can be done by using !=. (optional)excludeGloballyScoped
- Exclude globally scoped items. (optional, default to false)- Returns:
- AssetTreeOutputV1
- Throws:
ApiException
- if fails to make API call
-
getTreeRootNodesWithHttpInfo
public ApiClient.ApiResponse<AssetTreeOutputV1> getTreeRootNodesWithHttpInfo(List<String> scope, Integer offset, Integer limit, List<String> properties, Boolean excludeGloballyScoped) throws ApiException Get a collection of root nodes for the asset tree- Parameters:
scope
- The IDs of the workbooks to which the items are scoped<br>If the scope is set to the Empty GUID, then the scoped items are excluded. (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)properties
- A list of property names and values to filter on. Arguments should be passed in in the following format Property=Value, with each new property-value pair on a new line. The option to filter out a node by a property can be done by using !=. (optional)excludeGloballyScoped
- Exclude globally scoped items. (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
getTreeRootNodesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AssetTreeOutputV1> getTreeRootNodesWithHeadersAndHttpInfo(List<String> scope, Integer offset, Integer limit, List<String> properties, Boolean excludeGloballyScoped, Map<String, String> customHeaders) throws ApiExceptionGet a collection of root nodes for the asset tree- Parameters:
scope
- The IDs of the workbooks to which the items are scoped<br>If the scope is set to the Empty GUID, then the scoped items are excluded. (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)properties
- A list of property names and values to filter on. Arguments should be passed in in the following format Property=Value, with each new property-value pair on a new line. The option to filter out a node by a property can be done by using !=. (optional)excludeGloballyScoped
- Exclude globally scoped items. (optional, default to false)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
moveNodesToParent
public StatusMessageBase moveNodesToParent(String parentId, ItemIdListInputV1 body) throws ApiException Add the specified items as child nodes of the specified parent within the specified tree. If an item is already a member of this tree, it will move from its current parent to the specified parent. The children of the item being moved will move with it.- Parameters:
parentId
- ID of the parent node (required)body
- Item list (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
moveNodesToParentWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> moveNodesToParentWithHttpInfo(String parentId, ItemIdListInputV1 body) throws ApiException Add the specified items as child nodes of the specified parent within the specified tree. If an item is already a member of this tree, it will move from its current parent to the specified parent. The children of the item being moved will move with it.- Parameters:
parentId
- ID of the parent node (required)body
- Item list (required)- Throws:
ApiException
- if fails to make API call
-
moveNodesToParentWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> moveNodesToParentWithHeadersAndHttpInfo(String parentId, ItemIdListInputV1 body, Map<String, String> customHeaders) throws ApiExceptionAdd the specified items as child nodes of the specified parent within the specified tree. If an item is already a member of this tree, it will move from its current parent to the specified parent. The children of the item being moved will move with it.- Parameters:
parentId
- ID of the parent node (required)body
- Item list (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
moveNodesToRootOfTree
Add the specified items as root nodes of the specified tree. If an item is already a member of this tree, it will move to the root and its children will move with it- Parameters:
body
- Item list (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
moveNodesToRootOfTreeWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> moveNodesToRootOfTreeWithHttpInfo(ItemIdListInputV1 body) throws ApiException Add the specified items as root nodes of the specified tree. If an item is already a member of this tree, it will move to the root and its children will move with it- Parameters:
body
- Item list (required)- Throws:
ApiException
- if fails to make API call
-
moveNodesToRootOfTreeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> moveNodesToRootOfTreeWithHeadersAndHttpInfo(ItemIdListInputV1 body, Map<String, String> customHeaders) throws ApiExceptionAdd the specified items as root nodes of the specified tree. If an item is already a member of this tree, it will move to the root and its children will move with it- Parameters:
body
- Item list (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
rebuildSearchIndex
Trigger a rebuild of an asset tree search index in the background, starting at the specified root asset. This can be a time consuming and resource intensive operation, especially on large trees. The reindexing is performed in the background, and the API call will return as soon as the rebuild has been triggered.- Parameters:
rootAssetId
- ID the root asset of the tree to rebuild (required)- Throws:
ApiException
- if fails to make API call
-
rebuildSearchIndexWithHttpInfo
Trigger a rebuild of an asset tree search index in the background, starting at the specified root asset. This can be a time consuming and resource intensive operation, especially on large trees. The reindexing is performed in the background, and the API call will return as soon as the rebuild has been triggered.- Parameters:
rootAssetId
- ID the root asset of the tree to rebuild (required)- Throws:
ApiException
- if fails to make API call
-
rebuildSearchIndexWithHeadersAndHttpInfo
public void rebuildSearchIndexWithHeadersAndHttpInfo(String rootAssetId, Map<String, String> customHeaders) throws ApiExceptionTrigger a rebuild of an asset tree search index in the background, starting at the specified root asset. This can be a time consuming and resource intensive operation, especially on large trees. The reindexing is performed in the background, and the API call will return as soon as the rebuild has been triggered.- Parameters:
rootAssetId
- ID the root asset of the tree to rebuild (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
removeNodeFromTree
Remove an item and its children from the tree. (These items will still exist but not as part of this tree.)- Parameters:
id
- ID of the node to remove (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
removeNodeFromTreeWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> removeNodeFromTreeWithHttpInfo(String id) throws ApiException Remove an item and its children from the tree. (These items will still exist but not as part of this tree.)- Parameters:
id
- ID of the node to remove (required)- Throws:
ApiException
- if fails to make API call
-
removeNodeFromTreeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> removeNodeFromTreeWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionRemove an item and its children from the tree. (These items will still exist but not as part of this tree.)- Parameters:
id
- ID of the node to remove (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
scaleAcrossTree
Scale a tree item across its asset tree. Asset-swapped copies of the item will be inserted under all assets at the same tree level as its current parent.- Parameters:
id
- ID of the item to be scaled (required)- Returns:
- ScaleAcrossTreeOutputV1
- Throws:
ApiException
- if fails to make API call
-
scaleAcrossTreeWithHttpInfo
public ApiClient.ApiResponse<ScaleAcrossTreeOutputV1> scaleAcrossTreeWithHttpInfo(String id) throws ApiException Scale a tree item across its asset tree. Asset-swapped copies of the item will be inserted under all assets at the same tree level as its current parent.- Parameters:
id
- ID of the item to be scaled (required)- Throws:
ApiException
- if fails to make API call
-
scaleAcrossTreeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ScaleAcrossTreeOutputV1> scaleAcrossTreeWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionScale a tree item across its asset tree. Asset-swapped copies of the item will be inserted under all assets at the same tree level as its current parent.- Parameters:
id
- ID of the item to be scaled (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
treemap
public TreemapOutputV1 treemap(String start, String end, List<String> conditionIds, String swapId, String parentId, List<String> parameters, List<String> formulas) throws ApiException Build a treemap- Parameters:
start
- The start time under which to compute conditions for the treemap. (required)end
- The end time under which to compute conditions for the treemap. (required)conditionIds
- The IDs of the conditions that will be used to create the treemap; must be in order of priority, where the first condition is the highest priority item. (required)swapId
- The ID of the asset to swap each treemap leaf node with. (required)parentId
- The ID of the parent asset to build the treemap from. (required)parameters
- Parameters for the display formulas. Each parameter should have a format of 'name=id' where 'name' is the variable identifier, without the leading $ sign, and 'id' is the ID of the item referenced by the variable (optional)formulas
- A list of display scalar formulas (optional)- Returns:
- TreemapOutputV1
- Throws:
ApiException
- if fails to make API call
-
treemapWithHttpInfo
public ApiClient.ApiResponse<TreemapOutputV1> treemapWithHttpInfo(String start, String end, List<String> conditionIds, String swapId, String parentId, List<String> parameters, List<String> formulas) throws ApiException Build a treemap- Parameters:
start
- The start time under which to compute conditions for the treemap. (required)end
- The end time under which to compute conditions for the treemap. (required)conditionIds
- The IDs of the conditions that will be used to create the treemap; must be in order of priority, where the first condition is the highest priority item. (required)swapId
- The ID of the asset to swap each treemap leaf node with. (required)parentId
- The ID of the parent asset to build the treemap from. (required)parameters
- Parameters for the display formulas. Each parameter should have a format of 'name=id' where 'name' is the variable identifier, without the leading $ sign, and 'id' is the ID of the item referenced by the variable (optional)formulas
- A list of display scalar formulas (optional)- Throws:
ApiException
- if fails to make API call
-
treemapWithHeadersAndHttpInfo
public ApiClient.ApiResponse<TreemapOutputV1> treemapWithHeadersAndHttpInfo(String start, String end, List<String> conditionIds, String swapId, String parentId, List<String> parameters, List<String> formulas, Map<String, String> customHeaders) throws ApiExceptionBuild a treemap- Parameters:
start
- The start time under which to compute conditions for the treemap. (required)end
- The end time under which to compute conditions for the treemap. (required)conditionIds
- The IDs of the conditions that will be used to create the treemap; must be in order of priority, where the first condition is the highest priority item. (required)swapId
- The ID of the asset to swap each treemap leaf node with. (required)parentId
- The ID of the parent asset to build the treemap from. (required)parameters
- Parameters for the display formulas. Each parameter should have a format of 'name=id' where 'name' is the variable identifier, without the leading $ sign, and 'id' is the ID of the item referenced by the variable (optional)formulas
- A list of display scalar formulas (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateTree
Update an asset tree- Parameters:
body
- (optional)- Returns:
- AssetGroupOutputV1
- Throws:
ApiException
- if fails to make API call
-
updateTreeWithHttpInfo
public ApiClient.ApiResponse<AssetGroupOutputV1> updateTreeWithHttpInfo(AssetGroupInputV1 body) throws ApiException Update an asset tree- Parameters:
body
- (optional)- Throws:
ApiException
- if fails to make API call
-
updateTreeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AssetGroupOutputV1> updateTreeWithHeadersAndHttpInfo(AssetGroupInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate an asset tree- Parameters:
body
- (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-