Jump to

• Request
• Response

Get a report package

get

/epm/rest/v1/reportPackages/{id}

Request

Path Parameters

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

Query Parameters

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

  • Allowed Values: [ "all", "reportPackageId", "name", "description", "createdBy", "creationDate", "modifiedBy", "modificationDate", "preview" ]

  [
      "all",
      "reportPackageId",
      "name",
      "description",
      "createdBy",
      "creationDate",
      "modifiedBy",
      "modificationDate",
      "preview"
  ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request successful

Body ()

Root Schema : ReportPackage

Type: object

Report Package

Show Source

• createdBy: string
  Read Only: true
• creationDate: string (date-time)
  Read Only: true
• description: string
• libraryPath(required): string
• links: array links
  Read Only: true
• modifiedBy: string
  Read Only: true
• modifiedDate: string (date-time)
  Read Only: true
• name(required): string
• preview: array preview
  Read Only: true
• reportCenter: array reportCenter
  Read Only: true
• reportPackageId(required): string
  Read Only: true
• reportPackageType(required): string

{
    "required":[
        "libraryPath",
        "name",
        "reportPackageId",
        "reportPackageType"
    ],
    "type":"object",
    "properties":{
        "reportPackageId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "preview":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "reportCenter":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "readOnly":true
        },
        "modifiedDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "libraryPath":{
            "type":"string"
        },
        "reportPackageType":{
            "type":"string"
        }
    },
    "description":"Report Package"
}

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

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : reportCenter

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

400 Response

Invalid parameter

404 Response

Report Package ID not found

500 Response

Service Error

Back to Top