Skip to main content

/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 also save a configuration for the user _PUBLIC to a global location. _PUBLIC provides the application’s default user configuration for any user who has no custom configuration saved.

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. If no user is specified, Business Intelligence attempts to retrieve or modify the configuration for the current user.

ACTION

Optional. Provide the value "GET" to retrieve the configuration for the user. Provide the value "DELETE" to delete the configuration for the user. If no action is provided, Business Intelligence attempts to set the configuration for the user as specified by 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/CubesNext section
Previous section/Data/TestConnection
FeedbackOpens in a new tab