Help Center/ CodeArts Req/ API Reference/ APIs/ Project Information/ Obtaining Projects That an Account Has Not Joined

Updated on 2023-06-12 GMT+08:00

View PDF

Obtaining Projects That an Account Has Not Joined

Function

URI

GET /v4/projects/domain/not-added

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Specifies the paging index and offset. offset is an integer multiple of limit. limit=10,offset=0,10,20... Minimum: 0 Default: 0
limit	No	Integer	Number of records displayed on each page. A maximum of 100 records can be displayed on each page. Minimum: 1 Maximum: 100 Default: 10

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. 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	Total Minimum: 0 Maximum: 10000

**Table 4** projects
Parameter	Type	Description
project_num_id	Integer	Project ID
project_id	String	Project ID Minimum: 32 Maximum: 32
project_name	String	Project name Minimum: 1 Maximum: 128
description	String	Description
created_time	Long	Indicates the time when the project is created. Minimum: 0 Maximum: 13
updated_time	Long	Indicates the time when the project is updated. Minimum: 0 Maximum: 13
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 Minimum: 1 Maximum: 32
user_name	String	Creator name
domain_id	String	Creator tenant ID. Minimum: 1 Maximum: 32
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

Example Requests

Get https://{endpoint}/v4/projects/domain/not-added

Get https://{endpoint}/v4/projects/domain/not-added

Example Responses

Status code: 200

{
  "projects" : [ {
    "project_num_id" : 3056544,
    "project_id" : "e2da96a5d2c845e284f0ad47f8ca8cb1",
    "project_name" : "dsadasdsasss",
    "description" : "demo",
    "created_time" : "1571296951000",
    "updated_time" : "1571296951000",
    "project_type" : "scrum",
    "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" : 1
}