Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Contents

Request Method
URL Parameters
Request Body Details
Example Request
Sample Response

/Info/Config/:application

Configures (POST), retrieves (GET), or deletes (DELETE) a user configuration for the specified application. Using this API, each user can store their own custom configuration to a private location. A user who holds the appropriate administrator privilege (%DeepSee_Admin:U) can use this API to manage configurations for other users. An administrator can specify a default configuration for an application by defining a configuration for the user _PUBLIC; the API returns the _PUBLIC configuration for any user for whom no custom configuration is recorded.

Request Method

GET, POST or DELETE

URL Parameters

application

Required. This is the name of the application.

Request Body Details

This endpoint uses the following properties of the request body for POST requests:

USER

Optional. Used in combination with the ACTION property, the USER property allows an administrator to manage application configurations for other users, including the _PUBLIC user. If the user who has made the request is not an administrator, this property is ignored and the API updates the user’s own configuration with the contents of the CONFIG property. If no USER is specified, the requested operation is performed upon the configuration of the user who submitted the request.

ACTION

Optional. Used in combination with the USER property, the ACTION property allows an administrator to manage application configurations for other users: the value "GET" retrieves the configuration which is currently stored for the user; "DELETE" deletes it; "POST" updates its contents with the contents of the request’s CONFIG property. (When no ACTION value is specified, "POST" is assumed as the default.) If the user who has made the request is not an administrator, this property is ignored and the API updates the user’s own configuration with the contents of the CONFIG property.

CONFIG

Optional. This property is a JSON object containing custom configuration information.

For a given application, one JSON configuration object may be stored per user.

Example Request

Request Method:
POST
Request URL:
https://localhost/biserver/api/deepsee/v3/research/Info/Config/myapp
For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.

Request Body:

{
  "USER": "_PUBLIC",
  "ACTION": "",
  "CONFIG": {
    "CUSTOM1": "value1",
    "CUSTOM2": "value2",
    "CUSTOM3": [
      "value3",
      "value4",
      "value5"
    ]
  }
}

Sample Response

{
    "Info": {
        "Application": "myapp",
        "Error": ""
    },
    "Result": {}
}

/Info/Cubes

/Data/TestConnection