Jump to

• Request
• Response
• Examples

Get Buffer Settings

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/buffers

Returns buffer settings of the specified database.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Buffer settings retrieved successfully.

Body ()

Root Schema : buffers

Type: object

Show Source

• dataRetrievalBufferSize(optional): integer(int64)

  Retrieval buffer size allocated per retrieval request

• dataRetrievalSortBufferSize(optional): integer(int64)

  Retrieval sort buffer size allocated per retrieval request

{
    "type":"object",
    "properties":{
        "dataRetrievalBufferSize":{
            "type":"integer",
            "description":"<p>Retrieval buffer size allocated per retrieval request</p>",
            "format":"int64"
        },
        "dataRetrievalSortBufferSize":{
            "type":"integer",
            "description":"<p>Retrieval sort buffer size allocated per retrieval request</p>",
            "format":"int64"
        }
    },
    "xml":{
        "name":"buffers"
    }
}

400 Response

Bad Request

Failed to get the buffer settings. The application or database name may be incorrect.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get buffer settings for a cube.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/settings/buffers" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "buffers": {
    "dataRetrievalBufferSize": 20480,
    "dataRetrievalSortBufferSize": 20480
  }
}

Back to Top