Help Center/ DataArts Studio/ API Reference/ Data Lake Mall APIs/ Service Catalog Management/ Obtaining the Paths to a Catalog Through Its ID
Updated on 2022-09-15 GMT+08:00

Obtaining the Paths to a Catalog Through Its ID

Description

This API is used to obtain the paths of all the layers from the root directory to the current catalog based on the catalog ID.

URL

  • URI format

    GET /v1/{project_id}/service/servicecatalogs/{catalog_id}/layerpaths

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

    catalog_id

    Yes

    String

    Catalog ID

Request Message

  • Example request

    None

Response

  • Example response
    {
      "paths": [
        {
          "catalog_id": "2847131b4d5a26c5bd4bfd9d8f63f577",
          "name": "/demo",
          "order": 3
    }
        {
          "catalog_id": "3847131b4d565657g435536568f635342",
          "name": "/demo2",
          "order": 2
        }
        {
          "catalog_id": "450aa37131b4d5a26c5bcfd9d8f63j653",
          "name": "/demo1",
          "order": 1
        }
        {
          "catalog_id": "0",
          "name": "/",
          "order": 0
        }
      ]
    }
  • Response parameter description

    Parameter

    Type

    Description

    paths

    Dictionary

    Paths that are returned

    • paths parameters

      Parameter

      Type

      Description

      catalog_id

      String

      Catalog ID

      name

      String

      Name of a single path

      order

      Integer

      Catalog level

Status Code

Status Code

Description

200

The paths are obtained.

For details about status codes, see Status Codes.