Jump to

• Request
• Response

Get all books

get

/epm/rest/v1/books

Request

Query Parameters

• fields(required): array
  A comma separated list of fields to return for each Book. If no fields are specified, the default fields (bookId, name, description, createdBy, creationDate, modifiedDate, pathName) will be included.
• limit(required): integer(int64)
  The maximum number of Books to return.
• offset(required): integer(int64)
  The list of Books returned will start at this offset into the full list.
• orderBy(required): array
  A comma separated list of fields used to sort the list of Books being returned. The value is specified by the format "field:order" where order is either "asc" for ascending or "desc" for descending.
• q(required): string
  The query used to filter the Books. The expression format must adhere to the SCIM Protocol Filtering Specification RFC 7644 Section 3.4.2.2.

  Example:

  q=description co "Budget" and modifiedDate gt "2017-01-01T12:00:00Z"

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request successful

Body ()

Root Schema : ItemCollectionBook

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/Book"
            }
        },
        "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 : items

Type: array

Read Only: true

Show Source

• Array of: object Book
  Management Reporting Book

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

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

Type: object

Management Reporting Book

Show Source

• bookId: string
  Read Only: true
• 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 Book instance.
• description: string
  Read Only: true
• globalPov: object ItemCollectionPOVDimension
• 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
• output: array output
  Read Only: true

  A link to generate Book output in pdf or xlsx.
• pathName: string
  Read Only: true
• primaryDatasource: string
  Read Only: true
• systemPath: string
  Read Only: true
• validationMessages: array validationMessages
  Read Only: true

  The errors found when trying to validate the Book.

{
    "type":"object",
    "properties":{
        "bookId":{
            "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
        },
        "pathName":{
            "type":"string",
            "readOnly":true
        },
        "systemPath":{
            "type":"string",
            "readOnly":true
        },
        "output":{
            "type":"array",
            "description":"A link to generate Book output in pdf or xlsx.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "primaryDatasource":{
            "type":"string",
            "readOnly":true
        },
        "validationMessages":{
            "type":"array",
            "description":"The errors found when trying to validate the Book.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "datasourceNames":{
            "type":"array",
            "description":"The list of datasources referenced by this Book instance.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "globalPov":{
            "$ref":"#/components/schemas/ItemCollectionPOVDimension"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"Management Reporting Book"
}

Nested Schema : datasourceNames

Type: array

Read Only: true

The list of datasources referenced by this Book instance.

Show Source

• Array of: string

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

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

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : output

Type: array

Read Only: true

A link to generate Book output in pdf or xlsx.

Show Source

• Array of: object Link

{
    "type":"array",
    "description":"A link to generate Book output in pdf or xlsx.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : validationMessages

Type: array

Read Only: true

The errors found when trying to validate the Book.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The errors found when trying to validate the Book.",
    "readOnly":true,
    "items":{
        "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 : 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 : 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"
    }
}

400 Response

Invalid parameter

500 Response

Service Error

Back to Top