Skip to content
Developer home
X3

Folders listing

  Less than to read

The URL of the API can be found in the response of the root API :

        HTTPS 1.1 GET https://api.myregion-sagex3.com/v1
        {
        ...
        "customerUsage": {
                "folder": "https://api.myregion-sagex3.com/v1/folders",
        ...
            }
        }

When the X3 customer grants an access to customer-owned cluster, a scope is associated to this grant. The customer defines in this scope, a list of valid solution and folders that a 3rd party application will be able to access to.

The folders listing API lists all available navigable links of each folder inside X3 storage with the present access token.

  • Requirements for this step:

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

    • 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/folders
      
          {
              "folders": [
                  {
                      "name": "SEED",
                      "$urls": {
                          "dataIngestion": "https://api.customerregion-sagex3.com/v1/dataingestion/SEED/",
                          "dataDelivery": "https://api.customerregion-sagex3.com/v1/datadelivery/SEED/",
                          "dataService":  "https://api.customerregion-sagex3.com/v1/service/X3CLOUDV2_SEED/api"
                      }
                  },
                  {
                      "name": "X3",
                      "$urls": {
                          "dataIngestion": "https://api.customerregion-sagex3.com/v1/dataingestion/X3/",
                          "dataDelivery": "https://api.customerregion-sagex3.com/v1/datadelivery/X3/",
                          "dataService": "https://api.customerregion-sagex3.com/v1/service/X3CLOUDV2_X3/graphQL"
                      }
                  }
              ]
          }
      
    • By Postman (for demo purpose, region ‘qa’ is used)

      Folders listing