Jump to

• Request
• Response

Get Sandbox Details

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/sandbox

Returns details about sandbox members.

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

Sandbox details returned successfully; includes total sandbox members, available members, and assigned member.

Body ()

Root Schema : SandboxDetail

Type: object

Show Source

• assigned(optional): integer(int32)
• available(optional): integer(int32)
• links(optional): array links
• total(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "format":"int32"
        },
        "available":{
            "type":"integer",
            "format":"int32"
        },
        "assigned":{
            "type":"integer",
            "format":"int32"
        },
        "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 sandbox details. The application or database name may be incorrect, or the logged in user may not have the appropriate application role.

500 Response

Internal Server Error.

Back to Top