Help Center/ CodeArts Req/ API Reference/ APIs/ Project Information/ Obtaining Project Details

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

View PDF

Obtaining Project Details

Function

URI

GET /v4/projects/{project_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project.

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
project	project object	Project Information

**Table 4** project
Parameter	Type	Description
project_num_id	Integer	Project numId
project_id	String	Project UUID.
name	String	Project
created_on	Long	Indicates the time when the project is created.
updated_on	Long	Indicates the time when the project is updated.
project_type	String	Project Type
archive	Integer	Archived or Not
enterprise_id	String	Enterprise project ID.
project_code	String	Project Code
creator	creator object	Initiator Info

**Table 5** creator
Parameter	Type	Description
user_num_id	Integer	Creator num_id
user_id	String	UUID of the creator.
user_name	String	Creator name
domain_id	String	Creator tenant ID.
domain_name	String	Tenant name of the creator.
nick_name	String	Indicates the 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/0792b7d26cb74bd799cbae80063dc74a

Example Responses

Status code: 200

{
  "project" : {
    "project_num_id" : 3183801,
    "project_id" : "41bd3eab86544863b8fc92ffcd35e3c8",
    "name" : "aaa",
    "created_on" : 1576114296000,
    "updated_on" : 1576114296000,
    "project_type" : "scrum",
    "archive" : 1,
    "enterprise_id" : "041bd3eab86544863b8f92ffcd35e218",
    "project_code" : "abc_123",
    "creator" : {
      "user_num_id" : 4097,
      "user_id" : "c4bd39f0573a436589714bedbcca8536",
      "user_name" : "modile_user",
      "domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
      "domain_name" : "modile_user",
      "nick_name" : "Tom.M.Riddle"
    }
  }
}