Obtaining All Directories

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to obtain all directories.

URI

GET /v2/{project_id}/design/directorys

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Obtains the data in the directory and the data in all subdirectories (if there are any). Enumeration values: CODE STANDARD_ELEMENT

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
name	String	Name
description	String	Description
type	String	Directory type Enumeration values: STANDARD_ELEMENT TAG CODE
id	Long	ID
parent_id	Long	Parent directory ID. The root node does not have this ID.
prev_id	Long	ID of the previous node. The first node does not have this ID.
root_id	Long	Root node ID
qualified_name	String	Directory
create_time	String	Creation time
update_time	String	Update time
create_by	String	Creator
update_by	String	User who updated the directory
children	Array of DirectoryVO objects	Subdirectory

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. Catalogs with subcatalogs are returned.

[ {
  "name" : "db",
  "description" : "db",
  "type" : "db",
  "id" : "db",
  "parent_id" : "db",
  "prev_id" : "db",
  "root_id" : "db",
  "qualified_name" : "qname",
  "tenant_id" : "tid",
  "create_time" : 1111,
  "update_time" : 2222,
  "create_by" : "test",
  "update_by" : "test",
  "children" : [ {
    "name" : "child",
    "description" : "db",
    "xxxx" : "Other attributes",
    "children" : [ {
      "name" : "child_of_child",
      "xxxx" : "Other attributes"
    } ]
  } ]
} ]