Listing Intelligent Analysis Assistants

Function

This API is used to list intelligent analysis assistants.

URI

GET /v1/{project_id}/subjects

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
keyword	No	String	Name of the intelligent analysis assistant.
sort_dir	No	String	Sorting type. The options include: desc: descending order. asc: ascending order. Enumerated values: desc asc
sort_key	No	String	Sorting field.
limit	No	Integer	Number of returned entries. If not transferred, the first 10 records are queried by default.
offset	No	Integer	Start offset of returned entries.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Workspace-Id	Yes	String	Workspace ID. For how to obtain it, see Obtaining a Workspace ID.
X-Auth-Token	Yes	String	User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number of entries.
page_data	Array of ExtSubjectVO objects	Data on the current page. The element type is ExtSubjectVO.

**Table 5** ExtSubjectVO
Parameter	Type	Description
name	String	Name of the intelligent analysis assistant.
id	String	ID of the intelligent analysis assistant.
comments	String	Description of the intelligent analysis assistant.
status	Integer	Status of the intelligent analysis assistant. The options include 0 (initialization), 1 (chart construction), 2 (index construction), 3 (successful training), 4 (failed training), and 5 (stopped training). Enumerated values: 0 1 2 3 4 5
permission_list	Array of strings	Current user's sharing and collaboration permissions. The options are edit, export, use, and read.
workspace_id	String	ID of the workspace where the intelligent analysis assistant is located.
project_id	String	ID of the project the intelligent analysis assistant belongs to.
create_user	String	Creator of the intelligent analysis assistant.
create_user_name	String	Name of the creator of the intelligent analysis assistant.
create_date	Long	Time when the intelligent analysis assistant was created.
update_user	String	User who updates the intelligent analysis assistant.
update_user_name	String	Name of the user who updates the intelligent analysis assistant.
update_date	Long	Time when the intelligent analysis assistant was updated.
datasets	Array of ExtSubjectDatasetVO objects	List of datasets associated with the intelligent analysis assistant.
recommended_questions	String	Questions recommended by the intelligent analysis assistant.

**Table 6** ExtSubjectDatasetVO
Parameter	Type	Description
dataset_id	String	Dataset ID.
name	String	Dataset name.

Example Request

List intelligent analysis assistants.

GET https://{endpoint}/v1/{project_id}/subjects?subjects?keyword=&sort_key=&sort_dir=&limit=20&offset=0

Example Response

Status code: 200

Intelligent analysis assistants are successfully listed.

{
  "count" : 1,
  "page_data" : [ {
    "name" : "xxxxxxxxx",
    "subject_id" : "xxxxxxxxxxxxx",
    "comments" : "",
    "status" : 3,
    "permission_list" : [ "edit", "use" ],
    "workspace_id" : "xx4xxaxxxxac8x51xxx30",
    "project_id" : "xxb4dxx4xxx886xx33xx27",
    "create_user" : "xxxb4xxx4b0baxxxxx0dc18xxx3",
    "create_user_name" : "xxv_l00xxxx",
    "create_date" : 1702046652513,
    "update_user" : "xxxxxxx4b0xxxb8xxxx27x",
    "update_user_name" : "xxv_l00xxxx",
    "update_date" : 1710496061316,
    "datasets" : [ {
      "dataset_id" : "xxxxxxxxxxxxx",
      "name" : "xxxxxxxxxx"
    } ],
    "recommended_questions" : "xxxxxxxxxxxxx"
  } ]
}