Get a bursting definition
get
/epm/rest/v1/burstingDefinitions/{id}
Request
Path Parameters
-
id(required): string
The UUID of the Bursting Definition being requested.
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.
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
404 Response
Bursting Definition ID not found
500 Response
Service Error