You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Article.md
+77Lines changed: 77 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -261,6 +261,32 @@ Result:
261
261
"packageType":"bulk"
262
262
}
263
263
```
264
+
265
+
### More on /file-store/v1/packages parameters
266
+
267
+
Beside the ```packageName``` query, the ```/file-store/v1/packages``` endpoint supports the following optional parameters:
268
+
-*packageType*: Return all packages that match the specified package type.
269
+
-*bucketName*:Return all packages that are associated with the specified bucket name.
270
+
-*page*: Filter results by a specific pagination index (If client has already specified this query parameter, the
271
+
skipToken logic will be excluded)
272
+
-*includedTotalResult*: The total search result will be counting and added to the first response message.
273
+
-*skipToken*: A token to retrieve the next set of result that exceeds page size.
274
+
-*pageSize*: The number of packages that will be shown on one page. Default value is 25.
275
+
-*includedEntitilementResult*: CFS will perform a permission check on each package against the client
276
+
permission.
277
+
278
+
**Tips**
279
+
280
+
It is recommended to call the endpoint with ```pageSize=100``` parameter as follows:
281
+
282
+
```HTTP
283
+
GET /file-store/v1/packages?bucketName={bucket-name}&pageSize=100 HTTP/1.1
284
+
Host: api.refinitiv.com
285
+
Authorization: Bearer <Access Token>
286
+
```
287
+
288
+
Please find more detail on the [CFS API User Guide](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/documentation#cfs-api-user-guide) document.
289
+
264
290
## Step 3: Listing the FileSets using the Bucket Name and Package ID
265
291
266
292
Now we come to getting the FileSets information. The application needs to send an HTTP ```GET``` request to the RDP ```/file-store/v1/file-sets?bucket={bucket-name}&packageId={packageId}``` endpoint to list all FileSets under the input ```bucket-name``` and ```packageId```.
@@ -328,6 +354,46 @@ The FileSets response message from the API is as follows:
328
354
329
355
The File ID is in the ```files``` array above. I am demonstrating with the ```4c35-1775-c1a590ea-8376-ac6c1546b908``` file id.
330
356
357
+
### More on /file-store/v1/file-sets?bucket parameters
358
+
359
+
Beside the ```bucket``` and ```packageId```queries, the ```/file-store/v1/file-sets?bucket``` endpoint supports the following optional parameters:
360
+
361
+
-*name*: The name of the file-set. Only exactly matched results are returned.
362
+
-*packageId*: Package ID
363
+
-*status*: Filter file-set by status (Ready/Pending)
364
+
-*availableFrom*: Return all file-sets that become visible to permissioned users after the specified Datetime.
365
+
-*availableTo*: Return all file-sets that is no longer visible to permissioned user after the specified Datetime.
366
+
-*contentFrom*: Filter results by the age of the content within the file-set.
367
+
-*contentTo*: Filter results by the age of the content within the file-set.
368
+
-*createdSince*: Return all file-sets that have a created date after the specified Datetime
369
+
-*modifiedSince*: Return all file-sets that have a modified date after the specified Datetime.
370
+
-*attributes*: Return a list of publisher-defined attributes of the file-sets.
371
+
-*pageSize*: The number of file-sets that will be shown on one page. Default value is 25.
372
+
-*skipToken*: A token to retrieve the next set of file-set result that exceeds page size.
373
+
374
+
The ```modifiedSince``` parameter can help an application to limit the returned File-Set only for the File-Set that has been modified after a specified time.
375
+
376
+
**Tips**
377
+
378
+
It is recommended to call the endpoint with ```pageSize=100``` and ```modifiedSince``` parameters as follows:
379
+
380
+
```HTTP
381
+
GET /file-store/v1/file-sets?bucket={bucket-name}&packageId={packageId}&modifiedSince={datetime}&pageSize=100 HTTP/1.1
382
+
Host: api.refinitiv.com
383
+
Authorization: Bearer <Access Token>
384
+
```
385
+
386
+
Example:
387
+
388
+
```HTTP
389
+
GET /file-store/v1/file-sets?bucket=bulk-ESG&packageId=4288-ebb6-93372235-acb2-89882a826af1&pageSize=100&modifiedSince=2022-01-26T00:00:00Z HTTP/1.1
390
+
Host: api.refinitiv.com
391
+
Authorization: Bearer <Access Token>
392
+
```
393
+
394
+
Please find more detail on the [CFS API User Guide](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/documentation#cfs-api-user-guide) document.
395
+
396
+
331
397
### Step 3.1: Listing the packageId using the Bucket Name - Paging
332
398
333
399
My next point is the paging feature. By default, the ```/file-store/v1/file-sets?bucket={bucket-name}``` endpoint always returns 25 results per request. You can adjust the number of return results via the ```pageSize``` query parameter, the maximum number is **100**.
Beside the ```file_id``` query, the ```/file-store/v1/files/``` endpoint supports the following optional parameters:
591
+
592
+
-*createdSince*: Return all files that have a created date after the specified Datetime.
593
+
-*modifiedSince*: Return all files that have a modified date after the specified Datetime.
594
+
-*pageSize*: The number of files that will be shown on one page. Default value is 25.
595
+
-*skipToken*: A token to retrieve the next set of file result that exceeds page size
596
+
597
+
Please find more detail on the [CFS API User Guide](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/documentation#cfs-api-user-guide) document.
598
+
522
599
### Step 5: Downloading the file
523
600
524
601
That brings us to download the file. You can download the bulk file using that S3 URL (**as is**). **Do not alter or make any changes to the URL text string**. It will cause unable to download or signature mismatch error.
Copy file name to clipboardExpand all lines: RDP-Generic-CFS.html
+10-2Lines changed: 10 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -7917,6 +7917,12 @@ <h3 id="More-on-/file-store/v1/packages-parameters">More on /file-store/v1/packa
7917
7917
permission.</li>
7918
7918
</ul>
7919
7919
<p>Please find more detail on the <ahref="https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/documentation#cfs-api-user-guide">CFS API User Guide</a> document.</p>
7920
+
<p><strong>Tips</strong></p>
7921
+
<p>It is recommended to call the endpoint with <code>pageSize=100</code> parameter as follows:</p>
@@ -8134,12 +8140,14 @@ <h3 id="More-on-/file-store/v1/file-sets?bucket-parameters">More on /file-store/
8134
8140
<li><em>skipToken</em>: A token to retrieve the next set of file-set result that exceeds page size.</li>
8135
8141
</ul>
8136
8142
<p>The <code>modifiedSince</code> parameter can help an application to limit the returned File-Set only for the File-Set that has been modified after a specified time.</p>
Copy file name to clipboardExpand all lines: RDP-Generic-CFS.ipynb
+17-3Lines changed: 17 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -318,7 +318,17 @@
318
318
"- *includedEntitilementResult*: CFS will perform a permission check on each package against the client \n",
319
319
"permission.\n",
320
320
"\n",
321
-
"Please find more detail on the [CFS API User Guide](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/documentation#cfs-api-user-guide) document."
321
+
"Please find more detail on the [CFS API User Guide](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/documentation#cfs-api-user-guide) document.\n",
322
+
"\n",
323
+
"**Tips**\n",
324
+
"\n",
325
+
"It is recommended to call the endpoint with ```pageSize=100``` parameter as follows:\n",
"The ```modifiedSince``` parameter can help an application to limit the returned File-Set only for the File-Set that has been modified after a specified time. \n",
504
514
"\n",
515
+
"**Tips**\n",
516
+
"\n",
517
+
"It is recommended to call the endpoint with ```pageSize=100``` and ```modifiedSince``` parameters as follows:\n",
0 commit comments