Jump to

• Request
• Response
• Examples

Get Server Properties

get

/essbase/rest/v1/properties

Returns the Provider Services configuration properties available at the Essbase Server level to help you manage network timeout parameters.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Properties returned successfully, with links to get or edit the properties.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PropertyList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PropertyList"
    }
}

Nested Schema : PropertyList

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyEntry"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object PropertyEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PropertyEntry"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : PropertyEntry

Type: object

Show Source

• links(optional): array links
• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get properties.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to list the currently configured Provider Services properties for the Essbase Server. The Provider Services properties help you manage network timeout parameters.

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/properties?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "name" : "olap.server.netSocketTryInfinite",
    "value" : "false"
  }, {
    "name" : "olap.server.netRetryCount",
    "value" : "2950"
  } ]
}

Back to Top