Jump to

• Request
• Response

Get a report

get

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

Request

Path Parameters

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

Query Parameters

• fields(required): array
  A comma separated list of fields to return for each Report. If no fields are specified, the default fields (reportId, name, description) will be included.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request successful

Body ()

Root Schema : Report

Type: object

Management Reporting Report and Report Snapshot

Show Source

• createdBy: string
  Read Only: true
• creationDate: string (date-time)
  Read Only: true
• datasourceNames: array datasourceNames
  Read Only: true

  The list of datasources referenced by this Report or Report Snapshot instance.
• description: string
  Read Only: true
• executedReport: array executedReport
  Read Only: true

  A link to the Report or Report Snapshot's generated report output.
• globalPov: object ItemCollectionPOVDimension
• instanceType: string
  Read Only: true

  Allowed Values: [ "editor", "result", "snapshot" ]

  The Report instance type.
• invalidFields: array invalidFields
  Read Only: true

  The invalid fields found in the Report. The validation errors associated with these fields will be included in the Report's validation messages.
• lastAccessed: string (date-time)
  Read Only: true
• links: array links
  Read Only: true
• modifiedDate: string (date-time)
  Read Only: true
• name: string
  Read Only: true
• prompts: object ItemCollectionPrompt
• reportId: string
  Read Only: true
• validationMessages: array validationMessages
  Read Only: true

  The errors found when trying to validate the Report.

{
    "type":"object",
    "properties":{
        "reportId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "modifiedDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "lastAccessed":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "instanceType":{
            "type":"string",
            "description":"The Report instance type.",
            "readOnly":true,
            "enum":[
                "editor",
                "result",
                "snapshot"
            ]
        },
        "executedReport":{
            "type":"array",
            "description":"A link to the Report or Report Snapshot's generated report output.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "datasourceNames":{
            "type":"array",
            "description":"The list of datasources referenced by this Report or Report Snapshot instance.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "globalPov":{
            "$ref":"#/components/schemas/ItemCollectionPOVDimension"
        },
        "prompts":{
            "$ref":"#/components/schemas/ItemCollectionPrompt"
        },
        "invalidFields":{
            "type":"array",
            "description":"The invalid fields found in the Report. The validation errors associated with these fields will be included in the Report's validation messages.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "validationMessages":{
            "type":"array",
            "description":"The errors found when trying to validate the Report.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"Management Reporting Report and Report Snapshot"
}

Nested Schema : datasourceNames

Type: array

Read Only: true

The list of datasources referenced by this Report or Report Snapshot instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of datasources referenced by this Report or Report Snapshot instance.",
    "readOnly":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : executedReport

Type: array

Read Only: true

A link to the Report or Report Snapshot's generated report output.

Show Source

• Array of: object Link

{
    "type":"array",
    "description":"A link to the Report or Report Snapshot's generated report output.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : ItemCollectionPOVDimension

Type: object

Show Source

• count: integer (int32)
  Read Only: true
• hasMore: boolean
  Read Only: true
• items: array items
  Read Only: true
• limit: integer (int32)
• links: array links
  Read Only: true
• offset: integer (int32)
  Read Only: true
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/POVDimension"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : invalidFields

Type: array

Read Only: true

The invalid fields found in the Report. The validation errors associated with these fields will be included in the Report's validation messages.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The invalid fields found in the Report. The validation errors associated with these fields will be included in the Report's validation messages.",
    "readOnly":true,
    "items":{
        "type":"string"
    }
}

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 : ItemCollectionPrompt

Type: object

Show Source

• count: integer (int32)
  Read Only: true
• hasMore: boolean
  Read Only: true
• items: array items
  Read Only: true
• limit: integer (int32)
• links: array links
  Read Only: true
• offset: integer (int32)
  Read Only: true
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Prompt"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : validationMessages

Type: array

Read Only: true

The errors found when trying to validate the Report.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The errors found when trying to validate the Report.",
    "readOnly":true,
    "items":{
        "type":"string"
    }
}

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"
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object POVDimension
  A Dimension that has a set of members to select from for Report execution.

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

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 : POVDimension

Type: object

A Dimension that has a set of members to select from for Report execution.

Show Source

• dimensionId: string
  Read Only: true
• fixedSelection: boolean
  Read Only: true
• hidden: boolean
  Read Only: true
• links: array links
  Read Only: true
• name: string
  Read Only: true
• suggestedMembers: array suggestedMembers
  Read Only: true

  The dimension's members suggested for use when executing the Report.

{
    "type":"object",
    "properties":{
        "dimensionId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "suggestedMembers":{
            "type":"array",
            "description":"The dimension's members suggested for use when executing the Report.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/POVMember"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "hidden":{
            "type":"boolean",
            "readOnly":true
        },
        "fixedSelection":{
            "type":"boolean",
            "readOnly":true
        }
    },
    "description":"A Dimension that has a set of members to select from for Report execution."
}

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

The dimension's members suggested for use when executing the Report.

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",
    "description":"The dimension's members suggested for use when executing the Report.",
    "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 : items

Type: array

Read Only: true

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",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/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 : 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"
    }
}

400 Response

Invalid parameter

404 Response

Report UUID not found

500 Response

Service Error

Back to Top