Querying the Module List

This API is used to query all modules.

For details, see Calling APIs.

GET /v1/{project_id}/workspaces/{workspace_id}/soc/modules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	request offset, from 0
limit	No	Integer	Definition Data volume. Constraints N/A Range N/A Default Value N/A
sort_key	No	String	Definition Sorting field. create_time: creation time update_time: update time. Constraints N/A Range create_time update_time Default Value create_time
sort_dir	No	String	Definition Sorting order. ASC: ascending order DESC: descending order Constraints N/A Range ASC: ascending order DESC: descending order Default Value DESC
module_type	No	String	Module type, which can be tab or section.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A
content-type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID. Format: request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Error code.
data	Array of ModuleDetailInfo objects	Data list.
message	String	Error message.
offset	Integer	Page.
request_id	String	Request ID.
limit	Integer	Quantity.
success	Boolean	Whether the response is successful.
total	Integer	Total number.

**Table 6** ModuleDetailInfo
Parameter	Type	Description
cloud_pack_id	String	Subscription package ID.
cloud_pack_name	String	Subscription package name.
cloud_pack_version	String	Subscription package version.
create_time	String	Create time
creator_id	String	Creator id value
description	String	Description.
en_description	String	English description.
id	String	IID
module_json	String	Module information. When the module is an indicator card, the id field in items is also the indicator ID.
name	String	Name.
en_name	String	Name in English.
project_id	String	Tenant ID.
workspace_id	String	Workspace ID.
update_time	String	Update time.
thumbnail	String	Module thumbnail.
module_type	String	Module type, which can be tab or section.
tag	String	Module tag.
is_built_in	Boolean	Whether the module is a system module.
data_query	String	Data query mode.
boa_version	String	BOA base version.
version	String	SecMaster edition.