Skip to content
Developerhome
X3

Files listing

  Less than to read

The files listing API lists all available files of the current folder inside X3 storage and also a URL for each operation (Download or Delete).

There is a quota of requests per day for each customer. Therefore, a 3rd party application should let the customer specify the wait interval between two API calls to minimize the number of unnecessary requests. It could be 1min, 15mins, 1hour …

  • Requirements for this step:

    • Url of API to call: in our example, it will be https://api.customerregion-sagex3.com/v1/datadelivery/SEED/

    • A valid access token “XXXXXXX” for this endpoint obtained as shown in the previous step Token management

  • API call examples:

    • By curl command:

          curl -H "Authorization: Bearer XXXXXXX" https://api.customerregion-sagex3.com/v1/datadelivery/SEED/
      
          {
              "isTruncated": true,
              "maxItems": "50",
              "itemsCount": 50,
              "items": [
                  {
                      "key": "1.txt",
                      "downloadUrl": "SEED?filename=1.txt",
                      "lastModified": "2019-01-10T15:29:46.000Z",
                      "checksum": "\"b1946ac92492d2347c6235b4d2611184\"",
                      "size": 6,
                      "deleteUrl": "SEED?filename=1.txt"
                  },
                  {
                      "key": "10.txt",
                      "downloadUrl": "SEED?filename=10.txt",
                      "lastModified": "2019-01-10T15:29:46.000Z",
                      "checksum": "\"b1946ac92492d2347c6235b4d2611184\"",
                      "size": 6,
                      "deleteUrl": "SEED?filename=10.txt"
                  },
                  {
                      "key": "11.txt",
                      "downloadUrl": "SEED?filename=11.txt",
                      "lastModified": "2019-01-10T15:29:47.000Z",
                      "checksum": "\"b1946ac92492d2347c6235b4d2611184\"",
                      "size": 6,
                      "deleteUrl": "SEED?filename=11.txt"
                  },
                  ....
                  ,
                  {
                      "key": "53.txt",
                      "downloadUrl": "SEED?filename=53.txt",
                      "lastModified": "2019-01-10T15:30:06.000Z",
                      "checksum": "\"b1946ac92492d2347c6235b4d2611184\"",
                      "size": 6,
                      "deleteUrl": "SEED?filename=53.txt"
                  },
                  {
                      "key": "54.txt",
                      "downloadUrl": "SEED?filename=54.txt",
                      "lastModified": "2019-01-10T15:30:06.000Z",
                      "checksum": "\"b1946ac92492d2347c6235b4d2611184\"",
                      "size": 6,
                      "deleteUrl": "SEED?filename=54.txt"
                  }
              ],
              "$next": "SEED?page=2"
          }
      
    • By Postman Files listing