Querying the Subject List

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

View PDF

Function

This API is used to query subjects by name, creator, owner, status, or modification time.

URI

GET /v2/{project_id}/design/subjects

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Fuzzy query by name or code
create_by	No	String	Creator
owner	No	String	Query by owner
status	No	String	Business status Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
begin_time	No	String	Left boundary for a time filter. This parameter must be used together with end_time.
end_time	No	String	Right boundary for a time filter. This parameter must be used together with begin_time.
limit	No	Integer	Number of records to be queried, that is, Y records. The value ranges from 1 to 100. The default value is 50. Maximum: 100 Default: 50
offset	No	Integer	Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down. The default value is 0. Default: 0
parent_id	No	Long	Parent directory ID. The root directory does not have this ID. If this parameter is left empty, all parent directories will be queried. Value -1 indicates the ID of a directory under the root directory.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
name_ch	String	Chinese name Maximum: 600
name_en	String	English name Maximum: 600
description	String	Description Maximum: 2000
qualified_name	String	Extension name
guid	String	GUID, which is automatically generated
code	String	Code
alias	String	Alias
data_owner	String	Data owner
data_owner_list	String	Data owner list
data_department	String	Data domain
path	String	Path information
level	Integer	Level information
ordinal	Integer	Ordinal
owner	String	Owner Maximum: 4000
parent_id	Long	Parent catalog ID. If there is no parent catalog, the current catalog is the root catalog.
swap_order_id	Long	ID of the target node at the same level
id	Long	ID
qualified_id	String	Authentication ID, which is automatically generated
create_by	String	Creator
update_by	String	User who updated the catalog
create_time	String	Creation time
update_time	String	Update time
children_num	Integer	Number of sub-processes, excluding those of sub-processes. This parameter is not required for the front end.
children	Array of CatalogVO objects	Sub-catalog
self_defined_fields	Array of SelfDefinedFieldVO objects	Custom fields

**Table 4** SelfDefinedFieldVO
Parameter	Type	Description
fd_name_ch	String	Custom field name in Chinese Maximum: 200
fd_name_en	String	Custom field name in English Maximum: 200
not_null	Boolean	Whether the field is mandatory
fd_value	String	Field value

Status code: 400

**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: 401

**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

Status code: 403

**Table 7** 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: 404

**Table 8** 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. The CatalogVO array and the total number of subjects are returned.

{
  "name_ch" : "City traffic",
  "name_en" : "city_traffic",
  "description" : "",
  "qualified_name" : "city_traffic@Business.0cf68da0ba80f2962ff7c01ba8c0b7f7-workspace-f7eee36e67e541a59679f9b1b7f4eab0",
  "guid" : "f6e674d6-f657-4734-b417-837536c12eee",
  "code" : null,
  "alias" : "",
  "data_owner" : "",
  "data_owner_list" : "[\"abc\"]",
  "data_department" : null,
  "path" : "City traffic",
  "level" : 1,
  "ordinal" : 1,
  "owner" : "abc",
  "parent_id" : null,
  "swap_order_id" : null,
  "id" : "873232498044411904",
  "qualified_id" : null,
  "create_by" : "abc",
  "update_by" : "abc",
  "create_time" : "2021-08-06T15:54:11+08:00",
  "update_time" : "2022-08-30T10:59:38+08:00",
  "self_defined_fields" : [ {
    "fd_name_ch" : "Remarks",
    "fd_name_en" : "ez",
    "not_null" : false,
    "fd_value" : ""
  } ],
  "children_num" : null,
  "children" : null
}