Using a pre-existing instrument list and report template on DSS

mohamed.hisham
mohamed.hisham
in DSS

Hello,

I have 2 questions on DSS REST API:

1 - In the REST API Tutorial 9: On Demand extraction: instrument list -- we have a section showing how we can use instrument list existing in GUI in API. Is it possible to use pre-existing report template as well? If yes can you please provide sample format as shown in the tutorial for input list example as shown below.

"IdentifierList": {

"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentListIdentifierList",

"InstrumentListId":"0x077f534f54076163"


2 - Can I use pre existing input and report template id's in GUI while creating a scheduled API extraction as the tutorial only mentions about on demand extractions.

Tagged:

Best Answer

  • Jirapongse
    Jirapongse
    Answer ✓

    @mohamed.hisham

    Thank you for reaching out to us.

    1. No. With on-demand extractions, the report template is specified in the"@odata.type" property.

    {
      "ExtractionRequest": {
        "@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.EndOfDayPricingExtractionRequest",
        "ContentFieldNames": [
          "Ask Price",
          "Asset Category",
    ...

    2. Yes, you can use the pre-existing input and report template id's to create schedule extractions. Please refer to the REST API Tutorial 10: GUI control calls: immediate extract tutorial.

    The tutorial shows how to create an immediate extraction with the ListId and ReportTemplateId through the REST API. The endpoint URL is https://selectapi.datascope.refinitiv.com/RestApi/v1/Extractions/Schedules and the body contains.

    {
      "Name": "myImmediateSchedule",
      "Recurrence": {
        "@odata.type": "#DataScope.Select.Api.Extractions.Schedules.SingleRecurrence",
        "IsImmediate": true
      },
      "Trigger": {
        "@odata.type": "#DataScope.Select.Api.Extractions.Schedules.ImmediateTrigger",
        "LimitReportToTodaysData": true
      },
      "ListId": "0x080833021dedf0a1",
      "ReportTemplateId": "0x0808321dd61df091"
    }


Categories