Getting the Object Parameters of a Universe

Usage

Gets the list of object parameters used to prompt some values to the end-user and defined in data foundations and business layers of a UNX universe stored in the CMS repository.

Note This only relates to UNX universes since UNV universes do not support object parameters.
Request

GET /universes/<universeID>/prompts

Response

Response type: application/xml or application/json

Response body: the list of the object parameters (<prompt>) identified by the following elements:

  • <id>
  • <dataType>
  • <name>
  • <question>

Example

GET /universes/6660/prompts

<prompts>
    <prompt>
        <id>_HDBaULaYEeCH2d6gof1MOA</id>
        <dataType>Numeric</dataType>
        <name>Reference Quarter Number</name>
        <question>Reference Quarter Number:</question>
    </prompt>
    <prompt>
        <id>_PImaULaYEeCH2d6gof1MOA</id>
        <dataType>Numeric</dataType>
        <name>Reference Year Number</name>
        <question>Reference Year Number:</question>
    </prompt>
    <prompt>
        <id>_capysLIYEeCVLNpRXueEkA</id>
        <dataType>String</dataType>
        <name>Period Type</name>
        <question>Period Type:</question>
    </prompt>
    <prompt>
        <id>_lBRDMLIYEeCVLNpRXueEkA</id>
        <dataType>String</dataType>
        <name>Time Window</name>
        <question>Time Window:</question>
    </prompt>
    <prompt>
        <id>_uPlz8LIYEeCVLNpRXueEkA</id>
        <dataType>Date</dataType>
        <name>Reference Date</name>
        <question>Reference Date:</question>
    </prompt>
</prompts>