Jump to

• Request
• Response

Get the required member selection prompts for report

get

/epm/rest/v1/reports/{id}/prompts

Request

Path Parameters

• id(required): string
  The Report UUID being requested.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The member selection prompts required to execute the Report

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Prompt
  A Report's user selectable member values used to generate the report output. A member selction must be provided for each prompt during report execution.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Prompt"
    }
}

Nested Schema : Prompt

Type: object

A Report's user selectable member values used to generate the report output. A member selction must be provided for each prompt during report execution.

Show Source

• allowMultipleSelections: boolean
  Read Only: true
• defaultSelection: array defaultSelection
  Read Only: true
• dimensionName: string
  Read Only: true
• label: string
  Read Only: true
• links: array links
  Read Only: true
• promptId: string
  Read Only: true
• sourceElement: string
  Read Only: true
• sourceType: string
  Read Only: true
• suggestedMembers: array suggestedMembers
  Read Only: true

{
    "type":"object",
    "properties":{
        "promptId":{
            "type":"string",
            "readOnly":true
        },
        "label":{
            "type":"string",
            "readOnly":true
        },
        "dimensionName":{
            "type":"string",
            "readOnly":true
        },
        "allowMultipleSelections":{
            "type":"boolean",
            "readOnly":true
        },
        "sourceElement":{
            "type":"string",
            "readOnly":true
        },
        "sourceType":{
            "type":"string",
            "readOnly":true
        },
        "suggestedMembers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/POVMember"
            }
        },
        "defaultSelection":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/POVMember"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"A Report's user selectable member values used to generate the report output. A member selction must be provided for each prompt during report execution."
}

Nested Schema : defaultSelection

Type: array

Read Only: true

Show Source

• Array of: object POVMember
  A member that can be selected as part of the point of view or as the value for a Report prompt.

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/POVMember"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : suggestedMembers

Type: array

Read Only: true

Show Source

• Array of: object POVMember
  A member that can be selected as part of the point of view or as the value for a Report prompt.

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/POVMember"
    }
}

Nested Schema : POVMember

Type: object

A member that can be selected as part of the point of view or as the value for a Report prompt.

Show Source

• alias: string
  Read Only: true
• links: array links
  Read Only: true
• memberId: string
  Read Only: true
• name: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "memberId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "alias":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"A member that can be selected as part of the point of view or as the value for a Report prompt."
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• rel: string
  Allowed Values: [ "self", "next", "prev", "first", "canonical", "parent" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "prev",
                "first",
                "canonical",
                "parent"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

404 Response

Report UUID not found

500 Response

Service Error

Back to Top