Syntax and General Usage

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

• host

  The host of the ArcViz instance.

• port

  The port of the ArcViz instance.

• version

  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.

• data_type

  One of the ArcViz artifacts: users, groups, roles, datasets, connections, visuals, segments, or filter associations.

• object_id

  The id of the individual object, such as specific visual, or a specific dataset

• options

  Further request options, such as level of information details when 'detail=true'.

The HTTP method specifies the operation type:

GET

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.

POST

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.

Validate: To verify that the connection is successful, issue the POST command two times:

1. Issue the POST command with the validate flag set to true.

   [
     {
      "id":18,
      "name": "ArcEngine Dev",
      "type": "arcengine",
      "validate": "true",
      "info": {
      "PARAMS": {
      "HOST": "localhost",
      "PORT": "21051",
      "USERNAME": "admin",
      "SETTINGS": {
      "ANALYTICAL_VIEW_MAX_REFRESH_THREADS": "1",
      "MAX_PARTITIONS_FOR_REFRESH_INSERT": "1"
                  }
   .....
   .....
                }
             }
     }
   ]

2. On success, issue the same POST command without the validate flag. This step saves the data.

DELETE

Delete the specified item.