The API has a consistent pattern for each data type, with the following basic access syntax:
[http | https]:/host:port/arc/adminapi/version/data_type[/object_id][?options]
Where
The host of the ArcViz instance.
The port of the ArcViz instance.
The current API version is v1
. This increments
if the item data format changes. Whenever possible, we
intend to support older versions for backward
compatibility.
One of the ArcViz artifacts: users, groups, roles, datasets, connections, visuals, segments, or filter associations.
The id of the individual object, such as specific visual, or a specific dataset
Further request options, such as level of information details
when 'detail=true
'.
The HTTP method specifies the operation type:
List of an item identified though the
object_id
, or all items,
with default summary information. The URL option
'detail=true
' returns all data
details.
Update: the fields in the request data update the item
with matching object
_id
.
Create: if the URL or
request data does not specify the
object_id
, ArcViz creates a
new data item.
Delete the specified item.