Add Desciption to API data query

kai fang
kai fang Newcomer

Is there a way to add description information to a ExtractionNote API query.

When we run '/Jobs/JobGetActive' End Point to get actively running job, we could see a file Description in the return result, is there a way to customize that field, so that we could know what kind of data the JobId is requesting, and utilize this information to manage the data request better.


Best,


Kai


{'JobId': '0x0708e226d0617559',

'UserId': 9020249,

'Status': 'InProgress',

'StatusMessage': ' ',

'Description': 'ElektronTimeseriesReportTemplate Extraction',

'ProgressPercentage': 0,

'CreateDate': '2020-03-27T10:42:09.136Z',

'StartedDate': '2020-03-27T10:42:09.136Z',

'MonitorUrl': "https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ExtractRawResult(ExtractionId='0x0708e226d0617559')"},

{'JobId': '0x0706f393fd91716f',

'UserId': 9020249,

'Status': 'InProgress',

'StatusMessage': ' ',

'Description': 'ElektronTimeseriesReportTemplate Extraction',

'ProgressPercentage': 0,

'CreateDate': '2020-03-21T08:51:06.103Z',

'StartedDate': '2020-03-21T08:51:06.103Z',

'MonitorUrl': "https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ExtractRawResult(ExtractionId='0x0706f393fd91716f')"}]}>>>

Best Answer

  • Gurpreet
    Gurpreet admin
    Answer ✓

    Hello @kai fang

    A user cannot modify the description field. Your application can maintain a map job ID's with a custom description - when it starts a particular job.

    The description field will only list the kind of extraction being performed like - EndOfDayPricingReportTemplate Extraction etc.