Jump to

• Request
• Response

Add Sandbox Members

post

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

Adds members to an existing sandbox dimension.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Body ()

Size of sandbox dimension members. Default is 100 if body is empty.

Root Schema : SandboxRequestPayload

Type: object

Show Source

• size(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "size":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Sandbox members added successfully; includes links to sandbox details.

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 add sandbox members. The application or database name may be incorrect, or scenarios may not be enabled.

500 Response

Internal Server Error.

Back to Top