How can I find available ValidationOptions which I can call from DSS REST API?

I'd like to switch "Hybrid Instruments - Use EJV Fixed Income price source" user preference via DSS REST API. I am seeing sample code to define ValidationOptions but the sample doesn't include my target option. Is there any way to find all the available options?

regards,

Best Answer

  • Christiaan Meihsl
    Answer ✓

    @Zuka1,

    The API option for "Hybrid Instruments - Use EJV Fixed Income price source" is "UseDebtOverEquity" (yes I agree, it is not intuitive).

    In more detail:

    How to retrieve the full list of user preferences settings available in the API

    GET https://hosted.datascopeapi.reuters.com/RestApi/v1/Users/UserPreferences(PutYourUserIdHere)

    How to set user preferences using the API

    Use a PUT command to the same URI as for the GET. For the body, use the "ContentSettings" and "UiSettings" objects received from the GET, setting values for your needs.

    To make it easier for you to identify the options, below is the body of the PUT request with the full list of these preference settings, re-ordered to match the order of display in the user preferences screen (see also the screenshot):

    {
    "ContentSettings": {
    "PreferredIdentifier": "RIC",

    "ImportOfExpiredInstrumentsAllowed": true,
    "ImportOfOpenAccessRicsAllowed": true,
    "AllowHistoricalInstruments": true,
    "AllowLimitedTermInstruments": true,
    "ImportOfUnsupportedInstrumentAllowed": false,
    "ImportOfDuplicateInstrumentsAllowed": false,
    "ImportOfDuplicateLegalEntitiesAllowed": false,
    "IgnoreFinr": false,
    "UseDseOverLipper": false,
    "DefaultToUsExchange": false,
    "UseConsolidatedQuoteSourceForUsa": false,
    "UseConsolidatedQuoteSourceForCanada": false,
    "UseDebtOverEquity": true,
    "UseOtcPqSource": false,
    "RequireOfferingCodeMatch": false,

    "RicMaintenanceReportsEnabled": true,
    "PartialEmbargoedReportsEnabled": true,
    "IntermediateReportsEnabled": true,
    "DeltaReportsEnabled": true,
    "ReturnNullCodeValuesInExtractionPricingFields": false,
    "ReturnLastTradingDayPriceOnNonTradingDays": false,
    "IncludeDelistedRicsForFileCodeExpansion": true,
    "FiGlobalSnapshotPricesForPpxUs3Pm4PmEnabled": false,

    "AllowSubclassImport": false
    },
    "UiSettings": {
    "TimeZone": "W. Europe Standard Time",
    "LongDateFormatString": "MMMM dd, yyyy",
    "ShortDateFormatString": "ddMMyyyy",
    "LongTimeFormatString": "HH:mm:ss",
    "ShortTimeFormatString": "HH:mm",
    "DateSeparator": "-",
    "TimeSeparator": ":",
    "DecimalSeparator": ".",
    "GroupSeparator": ","
    }
    }

    PS: I'm not sure what the "AllowSubClassImport" one corresponds to, that is why it is isolated at the end.

Answers