For a deeper look into our DataScope Select REST API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
3 1 1 4

Extractions/ExtractWithNotes does not return "User Defined Identifier" & "User Defined Identifier2"

The Refinitiv DataScope REST API ExtractWithNotes does not return the "User Defined Identifier" &

"User Defined Identifier2" in the Extract Result Content, Although "User Defined Identifier" & "User Defined Identifier2" is part of extract as the API Extractions/CompositeReportTemplates('0x07199e3bd401904a') returns the above mentioned fields.
Please suggest and let us know how to get those two fields.

Following are the request and response JSON

URL: https://selectapi.datascope.refinitiv.com/RestApi/v1/Extractions/ExtractWithNotes
Request Body: {
"ExtractionRequest": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.CompositeExtractionRequest",
"ContentFieldNames": [
"Instrument ID Type",
"Instrument ID",
"CUSIP",
"CIN Code",
"SEDOL",
"OCC Code",
"ISIN",
"Ticker",
"RIC",
"Security Description",
"Currency Code Scaled",
"Country of Issuance",
"Domicile",
"Asset Type",
"Asset Type Description",
"Asset SubType",
"Asset SubType Description",
"Organizational SubType Code",
"Organizational SubType Description",
"Refinitiv Classification Scheme",
"Refinitiv Classification Scheme Description",
"Structured Security Flag",
"Market Capitalization",
"Issue Date",
"Maturity Date",
"Coupon Rate",
"Next Pay Date",
"Coupon Frequency",
"Coupon Frequency Description",
"Callable Flag",
"Next Call Date",
"Next Call Price",
"Accrual Date",
"Annualized Dividend Adjusted Gross Amount",
"Day Count Code Description",
"Underlying CUSIP",
"Dividend 1 Ex Date",
"Dividend 1 Record Date",
"Exchange Description",
"Exchange Code",
"Put Call Flag",
"Dividend Yield",
"Dividend 1 Pay Date",
"Dividend 1 Rate",
"Dividend 1 Is Pay Date Set Flag",
"Dividend 1 Currency",
"Emerging Market Flag",
"ETF Type",
"Municipal State",
"Standard Deviation - 1 Year",
"Standard Deviation - 10 Years",
"Standard Deviation - 3 Years",
"Standard Deviation - 5 Years",
"Coupon Type Description",
"Expiration Date",
"User Defined Identifier",
"User Defined Identifier2",
"First Coupon Date"
],
"IdentifierList": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{
"Identifier": "60412ADJ9",
"IdentifierType": "Cusip",
"Source": "EJV",
"UserDefinedIdentifier": null,
"UserDefinedIdentifier2": null,
"UserDefinedIdentifier3": null,
"UserDefinedIdentifier4": null,
"UserDefinedIdentifier5": null,
"UserDefinedIdentifier6": null
}
],
"ValidationOptions": {
"AllowHistoricalInstruments": false,
"AllowInactiveInstruments": true,
"AllowLimitedTermInstruments": false,
"AllowOpenAccessInstruments": false,
"AllowSubclassImport": false,
"AllowUnsupportedInstruments": true,
"ExcludeFinrAsPricingSourceForBonds": true,
"UseConsolidatedQuoteSourceForCanada": false,
"UseConsolidatedQuoteSourceForUsa": true,
"UseDebtOverEquity": false,
"UseExchangeCodeInsteadOfLipper": true,
"UseOtcPqSource": false,
"UseUsQuoteInsteadOfCanadian": true
},
"UseUserPreferencesForValidationOptions": false
},
"Condition": {
"ScalableCurrency": true
}
}
}
Response: {
    "@odata.context": "https://selectapi.datascope.refinitiv.com/RestApi/v1/$metadata#DataScope.Select.Api.Extractions.ExtractionRequests.ExtractionResult",
    "Contents": [
        {
            "IdentifierType": "Cusip",
            "Identifier": "60412ADJ9",
            "Instrument ID Type": "CSP",
            "Instrument ID": "60412ADJ9",
            "CUSIP": "60412ADJ9",
            "CIN Code": null,
            "SEDOL": null,
            "OCC Code": null,
            "ISIN": "US60412ADJ97",
            "Ticker": "MN",
            "RIC": null,
            "Security Description": "MN     3.100 08/01/28 '25",
            "Currency Code Scaled": "USD",
            "Country of Issuance": "US",
            "Domicile": "US",
            "Asset Type": "MUNI",
            "Asset Type Description": "Municipals",
            "Asset SubType": "MUNI",
            "Asset SubType Description": "Municipals",
            "Organizational SubType Code": null,
            "Organizational SubType Description": null,
            "Refinitiv Classification Scheme": "BOND",
            "Refinitiv Classification Scheme Description": "Bonds",
            "Structured Security Flag": null,
            "Market Capitalization": null,
            "Issue Date": "2015-08-19",
            "Maturity Date": "2028-08-01",
            "Coupon Rate": 3.1,
            "Next Pay Date": "2023-08-01",
            "Coupon Frequency": 2,
            "Coupon Frequency Description": "Semiannually",
            "Callable Flag": "Y",
            "Next Call Date": "2025-08-01",
            "Next Call Price": 100,
            "Accrual Date": "2015-08-19",
            "Annualized Dividend Adjusted Gross Amount": null,
            "Day Count Code Description": "30/360 (Bond Basis), 30/360 ISDA, 30-360 U.S. Municipal",
            "Underlying CUSIP": null,
            "Dividend 1 Ex Date": null,
            "Dividend 1 Record Date": null,
            "Exchange Description": "REFINITIV PRICING SERVICE",
            "Exchange Code": "EJV",
            "Put Call Flag": null,
            "Dividend Yield": null,
            "Dividend 1 Pay Date": null,
            "Dividend 1 Rate": null,
            "Dividend 1 Is Pay Date Set Flag": null,
            "Dividend 1 Currency": null,
            "Emerging Market Flag": null,
            "ETF Type": null,
            "Municipal State": "MN",
            "Standard Deviation - 1 Year": null,
            "Standard Deviation - 10 Years": null,
            "Standard Deviation - 3 Years": null,
            "Standard Deviation - 5 Years": null,
            "Coupon Type Description": "Fixed:Plain Vanilla Fixed Coupon",
            "Expiration Date": null,
            "First Coupon Date": "2016-02-01"
        }
    ],
    "Notes": [
        "Extraction Services Version 17.0.45072 (304b42dc3568), Built Feb  9 2023 15:49:06\r\nHoliday Rollover of Universal Close Price requested.\r\nProcessing started at 20230403 01:06:14 PM.\r\nUser ID: 9024916\r\nExtraction ID: 2000000537491220\r\nCorrelation ID: CiD/9024916/AAAAAA.086ba59234d8ab76/RA\r\nSchedule: 0x086ba59234e8ab76 (ID = 0x0000000000000000)\r\nInput List (1 items):  (ID = 0x086ba59234e8ab76) Created: 20230403 01:06:14 PM Last Modified: 20230403 01:06:14 PM\r\nReport Template (62 fields): _OnD_0x086ba59234e8ab76 (ID = 0x086ba5923508ab76) Created: 20230403 01:06:12 PM Last Modified: 20230403 01:06:12 PM\r\nSchedule dispatched via message queue (0x086ba59234e8ab76)\r\nSchedule Time: 20230403 01:06:14 PM\r\nNo prices needed currency scaling.\r\nProcessing completed successfully at 20230403 01:06:15 PM, taking 0.705 Secs.\r\nExtraction finished at 20230403 05:06:15 PM UTC, with servers: x04q24, QSDHA1 (0.0 secs), QSHC15 (0.1 secs), QSa01b (0.4 secs)\r\nUsage Summary for User 9024916, Client 110902, Template Type Composite\r\nBase Usage\r\n        Instrument                          Instrument                   Terms          Price\r\n  Count Type                                Subtype                      Source         Source\r\n------- ----------------------------------- ---------------------------- -------------- ----------------------------------------\r\n      1 Municipals                                                       N/A            N/A\r\n-------\r\n      1 Total instrument charged.\r\n      0 Instruments with no reported data.\r\n=======\r\n      1 Instrument in the input list.\r\nPremium Usage: Fixed Income Valuations\r\n        Instrument                          Instrument                   Terms          Price\r\n  Count Type                                Subtype                      Source         Source\r\n------- ----------------------------------- ---------------------------- -------------- ----------------------------------------\r\n      1 Municipals                                                       N/A            N/A\r\n-------\r\n      1 Total instrument charged.\r\n      0 Instruments with no reported data.\r\n=======\r\n      1 Instrument in the input list.\r\nNo Evaluated Pricing Service complex usage to report -- 1 Instrument in the input list had no reported data.\r\nWriting RIC maintenance report.\r\n",
        "Identifier,IdentType,Source,RIC,RecordDate,MaintType,OldValue,NewValue,Factor,FactorType\r\n"
    ]
}


dss-rest-api#producton-demand-extraction
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Hi @cabissi ,

Thank you for your participation in the forum. Is the reply below satisfactory in resolving your query?

If so please can you click the 'Accept' text next to the appropriate reply? This will guide all community members who have a similar question.

Thanks,
AHS

Please be informed that a reply has been verified as correct in answering the question, and has been marked as such.

Thanks,

AHS

1 Answer

· Write an Answer
Upvotes
Accepted
14.2k 30 5 10

Hi @cabissi ,

It could be because the value of the field in the request body is null, I try to put some value into User Defined Identifier fields and getting the response below1680591135282.png


1680591135282.png (88.5 KiB)
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.