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

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
aleksandra.kluczniak_refinitiv avatar image
1 ●0 ●0 ●1

DSS REST API - Entity/Instrument List automated update

Question about DSS REST API for a client, whose universe of Legal Entities is changing on a baily basis. Although it refers to EntityList specifically, but the same applies to InstrumentList.


Client is not happy with the fact that when using REST API, he has to build a new EntityList for every API call. Instead, he would like to insert an EntityList ID into API request/call – this list would be updated on a daily basis. So he would like to use a similar mechanism as with FTP, where the list of instruments/entities is updated on client’s server and linked to DSS schedule.


Is there a way that within the request (API call) the user can point to ‘EntityList’ Id, instead of having to build the standard request (API call) with all the entity Ids enumerated within?


dss-rest-apidatascope-selectdss
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.

zoya faberov avatar image zoya faberov

Hello @aleksandra.kluczniak_refinitiv,

Can we please confirm, which part fails for the client?

They are using scheduled extraction request, not on demand ad-hoc, right?

They have created an EntityList?

They are submitting ListId of their EntityList into Schedule->Create?

They update EntityList?

Please provide any details that are relevant to better understand the issue,

Thanks


wasin.w avatar image   wasin.w

Hello @aleksandra.kluczniak_refinitiv

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

wasin.w avatar image   wasin.w

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
marc.defilippis avatar image
51 ●0 ●0 ●1

Below an example, the training reference are the 2 links below:

GetByName https://hosted.datascopeapi.reuters.com/RestApi.Help/Context/Operation?ctx=Extractions&ent=EntityList&opn=GetByName

ReplaceAllWithIdentifiersWithOptions https://hosted.datascopeapi.reuters.com/RestApi.Help/Context/Operation?ctx=Extractions&ent=EntityList&opn=ReplaceAllWithIdentifiersWithOptions


Example:


I created an entity list named Aleksandra_Entities:



First get the entity List ID by making a GET on:

https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/EntityListGetByName(ListName='Aleksandra_Entities')


answer is:

{

"@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#EntityLists/$entity",

"ListId": "0x0776a0a40a974ddd",

"Name": "Aleksandra_Entities",

"Count": 1,

"Created": "2021-03-03T05:02:08.903Z",

"Modified": "2021-03-03T05:02:47.973Z"

}


Then to update it [in a FTP like fashion which is a full replace] use the following [I am replacing adidas with puma and Nike in the list]

POST on https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/EntityLists('0x0776a0a40a974ddd')/ThomsonReuters.Dss.Api.Extractions.EntityListReplaceAllWithIdentifiersWithOptions

With the following payload:


{

"Identifiers": [

{

"Identifier": "NKE",

"IdentifierType": "Ric",

"UserDefinedIdentifier": "UserIdentReplace"

},

{

"Identifier": "PUMG.DE",

"IdentifierType": "Ric",

"UserDefinedIdentifier": "UserIdentReplace"

}

],

"Options": {

"AllowDuplicateInstruments": false,

"IncludeParentAndUltimateParent": false,

"AllowUnmanagedOrUnverifiedEntities": true

}

}



Then the list is updated:





1614749974274.png (29.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.