Jump to

• Request
• Response

Get Maintenance Settings

get

/essbase/rest/v1/settings/maintenance

Gets the platform service maintenance settings, such as disk space and memory.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Saved platform service resource settings returned successfully.

Body ()

Root Schema : Limits

Type: object

Show Source

• coreFileSize(optional): object Limit
• dataSegmentSize(optional): object Limit
• maxMemory(optional): object Limit
• openFiles(optional): object Limit
• userMaxProcesses(optional): object Limit
• virtualMemorySize(optional): object Limit
• webLogicHeapSize(optional): object Limit

{
    "type":"object",
    "properties":{
        "coreFileSize":{
            "$ref":"#/definitions/Limit"
        },
        "dataSegmentSize":{
            "$ref":"#/definitions/Limit"
        },
        "maxMemory":{
            "$ref":"#/definitions/Limit"
        },
        "openFiles":{
            "$ref":"#/definitions/Limit"
        },
        "userMaxProcesses":{
            "$ref":"#/definitions/Limit"
        },
        "virtualMemorySize":{
            "$ref":"#/definitions/Limit"
        },
        "webLogicHeapSize":{
            "$ref":"#/definitions/Limit"
        }
    }
}

Nested Schema : Limit

Type: object

Show Source

• description(optional): string
• id(optional): string
• maximum(optional): integer(int64)
• minimum(optional): integer(int64)
• name(optional): string
• showUnlimited(optional): boolean
• unlimited(optional): boolean
• value(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "unlimited":{
            "type":"boolean"
        },
        "showUnlimited":{
            "type":"boolean"
        },
        "minimum":{
            "type":"integer",
            "format":"int64"
        },
        "maximum":{
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

Bad Request

Failed to get resource settings.

Back to Top