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

/Config

Sets (POST), retrieves (GET), or deletes (DELETE) a user configuration which a client application can access immediately after the user authenticates, before it has received information about the specific namespaces to which the user has access. Using this API, each authenticated user can store and retrieve their own configuration. A user who holds the appropriate administrator privilege (%DeepSee_Admin:U), can delete any existing user configuration. In addition, an administrator can save a configuration with the username %DEFAULT. %DEFAULT provides the application’s default user configuration for any user who has no custom configuration saved.

Request Method

GET, POST, or DELETE

URL Parameters

username

Optional. To delete the configuration associated with a username, an administrator can issue a DELETE request to this endpoint with the username supplied as the subpath (for example: https://localhost/biserver/api/deepsee/v3/Config/fbar)

Request Body Details

This endpoint uses the following properties of the request body:

USERNAME

Optional. USERNAME allows an administrator to manage configurations for other users. If the user who has made the request is not an administrator, this property is ignored. If no USERNAME is specified, Business Intelligence attempts to retrieve or modify the configuration for the current user.

CONFIG

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

Example Request

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

Note:

All valid versions of the Business Intelligence REST API support this service.

Request Body:

{
  "USERNAME": "%DEFAULT",
  "CONFIG": {
    "Version": 3,
    "Namespace": "SALES",
    "Last": "TransactionMap.dashboard",
    "CUSTOM4": "value4",
    "CUSTOM5": "value5",
    "CUSTOM6": [
        "value6",
        "value7",
        "value8"
    ]
  }
}

Sample Response

{
    "Info": {
        "Error": "",
        "Application": "/api/deepsee/",
        "CONFIG": {
            "Version": 3,
            "Namespace": "SALES",
            "Last": "TransactionMap.dashboard",
            "CUSTOM4": "value4",
            "CUSTOM5": "value5",
            "CUSTOM6": [
                "value6",
                "value7",
                "value8"
            ]
        },
        "USERNAME": "%DEFAULT"
    },
    "Result": {}
}

/Data/Favorites/:folderItem

/Command/WriteToRegistry