Get all bursting definitions
get
/epm/rest/v1/burstingDefinitions
Request
Query Parameters
-
fields(required): array
A comma separated list of fields to return for each Bursting Definition. If no fields are specified, the default fields (burstingDefinitionId, name, description) will be included.
-
limit(required): integer(int64)
The maximum number of Bursting Definitions to return.
-
offset(required): integer(int64)
The list of Bursting Definitions 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 Bursting Definitions 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 Bursting Definitions. 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 TopResponse
Supported Media Types
- application/json
200 Response
Request successful
Root Schema : BurstingDefinition
Type:
Show Source
object
-
burstingDefinitionId: string
Read Only:
true
-
createdBy: string
Read Only:
true
-
creationDate: string
(date-time)
Read Only:
true
-
description: string
-
lastAccessedDate: string
(date-time)
Read Only:
true
-
libraryDisplayPath: string
Read Only:
true
-
librarySystemPath: string
Read Only:
true
-
links: array
links
Read Only:
true
-
modifiedBy: string
Read Only:
true
-
modifiedDate: string
(date-time)
Read Only:
true
-
name: string
-
validationMessages: array
validationMessages
Read Only:
true
The errors found when trying to validate the Bursting Definition.
Nested Schema : validationMessages
Type:
array
Read Only:
true
The errors found when trying to validate the Bursting Definition.
Show Source
Nested Schema : Link
Type:
Show Source
object
-
href: string
-
rel: string
Allowed Values:
[ "self", "next", "prev", "first", "canonical", "parent" ]
400 Response
Invalid parameter
500 Response
Service Error