Jump to

• Request
• Response

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: array[string]
  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.

  • Allowed Values: [ "all", "burstingDefinitionId", "name", "description", "createdBy", "creationDate", "modificationDate", "lastAccessed", "libraryDisplayPath", "librarySystemPath", "validationMesages", "burst" ]

  [
      "all",
      "burstingDefinitionId",
      "name",
      "description",
      "createdBy",
      "creationDate",
      "modificationDate",
      "lastAccessed",
      "libraryDisplayPath",
      "librarySystemPath",
      "validationMesages",
      "burst"
  ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request successful

Body ()

Root Schema : BurstingDefinition

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "burstingDefinitionId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "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
        },
        "lastAccessedDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "validationMessages":{
            "type":"array",
            "description":"The errors found when trying to validate the Bursting Definition.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "libraryDisplayPath":{
            "type":"string",
            "readOnly":true
        },
        "librarySystemPath":{
            "type":"string",
            "readOnly":true
        }
    }
}

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

Type: array

Read Only: true

The errors found when trying to validate the Bursting Definition.

Show Source

• Array of: string

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

400 Response

Invalid parameter

404 Response

Bursting Definition ID not found

500 Response

Service Error

Back to Top