Querying Projects

Function

Querying Projects

URI

GET /v4/projects

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	The offset starts from 0. Minimum: 0 Maximum: 10000 Default: 0
limit	Yes	Integer	The minimum value is 1 and the maximum value is 1000. Minimum: 1 Maximum: 1000 Default: 10
search	No	String	Fuzzy query of project names or descriptions. Advanced query such as wildcard characters is not supported.
project_type	No	String	Project Type scrum\|xboard
sort	No	String	Sorting condition. By default, the creation time is sorted in descending order (name\|created_on)(asc\|desc).
archive	No	String	Indicates whether to archive. true: yes; false: no
query_type	No	String	By default, the list of projects that the current user participates in is returned. domain_projects indicates the list of all projects under the tenant. absent indicates the list of tenant projects that the current user does not participate in.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
projects	Array of projects objects	Project Information List
total	Integer	Number of projects Minimum: 0 Maximum: 10000

**Table 4** projects
Parameter	Type	Description
project_num_id	Integer	Project numId
project_id	String	Project UUID.
project_name	String	Project
description	String	Description
created_time	Long	Indicates the time when the project is created.
updated_time	Long	Indicates the time when the project is updated.
project_type	String	Project Type
creator	creator object	Initiator Info

**Table 5** creator
Parameter	Type	Description
user_num_id	Integer	Creator numId
user_id	String	Creator ID
user_name	String	Creator name
domain_id	String	Creator tenant ID.
domain_name	String	Tenant name of the creator.
nick_name	String	Tenant nickname of the creator.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

GET https://{endpoint}/v4/projects?limit=10&offset=0&project_type=scrum&sort=&search=aa&archive=true&query_type=domain_projects

Get https://{endpoint}/v4/projects?limit=10&offset=0&project_type=scrum&sort=&search=aa&archive=true&query_type=domain_projects

Example Responses

Status code: 200

{
  "projects" : [ {
    "project_num_id" : 3183801,
    "project_id" : "41bd3eab86544863b8fc92ffcd35e3c8",
    "project_name" : "aaa",
    "description" : "demo",
    "created_time" : 1576114296000,
    "updated_time" : 1576114296000,
    "project_type" : "xboard",
    "creator" : {
      "user_num_id" : 4097,
      "user_id" : "c4bd39f0573a436589714bedbcca8536",
      "user_name" : "modile_user",
      "domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
      "domain_name" : "modile_user",
      "nick_name" : "Tom.M.Riddle"
    }
  } ],
  "total" : 10
}