Admin API parameters and their syntax.
The Admin 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]
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, filter associations, or workspaces.
The id of the individual object, such as a specific user, visual, or a specific dataset. You can either use the object_id or the object_name in the syntax, not both.
object_nameThe name of the individual object, such as a specific user, visual, or a specific dataset. You can either use the object_id or the object_name in the syntax, not both.
Further request options, such as level of information details
when 'detail=true
'.
The address of the API management system, in the
form
[http|htttps]://host:port/arc/adminapi/version
.
To authenticate the end user, address of the
login URL, in the form
[http|https]:/host:port/arc/apps/login
.