Updated on 2025-09-10 GMT+08:00

Adding a Custom Work Item Module

Function

This API is used to add a custom work item module.

Calling Method

For details, see Calling APIs.

URI

POST /v2/module/modules

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Definition:

Description field that provides more details about the project or task.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

name

No

String

Definition:

Name of a work item module.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

owner

No

String

Definition:

Digital ID of the module owner, which is obtained by calling the Obtaining the Member List of a Specified Project API. The value of user_num_id in the response message body is the ID of the module owner.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

No

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

parent_num_id

No

String

Definition:

Unique ID of a parent task. The value is obtained by calling the Querying the Module Settings API. The value of id in modules in the response message body is the module ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

status

String

Definition:

Result status.

Value range:

N/A

Table 4 result

Parameter

Type

Description

module

module object

Definition:

Detailed information about a module.

Table 5 module

Parameter

Type

Description

description

String

Definition:

Module description.

Value range:

N/A

id

Integer

Definition:

Module ID.

Value range:

N/A

name

String

Definition:

Module name.

Value range:

N/A

owner

owner object

Definition:

Module owner.

project

project object

Definition:

Project information.

path

String

Definition:

Path of a module.

Value range:

N/A

path_name

String

Definition:

Name of a module path.

Value range:

N/A

Table 6 owner

Parameter

Type

Description

id

Integer

Definition:

Digital ID of the owner.

Value range: N/A

name

String

Definition:

Username of the owner.

Value range:

N/A

identifier

String

Definition:

Owner ID.

Value range:

N/A

nick_name

String

Definition:

Owner alias.

Value range:

N/A

Table 7 project

Parameter

Type

Description

id

Integer

Definition:

Digital ID of a project.

Value range:

N/A

identifier

String

Definition:

Unique ID of a project.

Value range:

N/A

name

String

Definition:

Project name.

Value range:

N/A

type

String

Definition:

Project type.

Value range:

N/A

Example Requests

POST http://{endpoint}/v2/module/modules?_=1753684289689

{
  "description" : "",
  "name" : "Asada",
  "owner" : "4091",
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "parent_num_id" : ""
}

Example Responses

Status code: 200

OK (The request has succeeded).

{
  "result" : {
    "module" : {
      "description" : "",
      "id" : 886637,
      "name" : "Asada",
      "owner" : {
        "id" : 4091,
        "name" : "devcloud_devcloud_s00404480_01",
        "identifier" : "a360371833bf4c558f796fd707b44daf",
        "nick_name" : "Sam 1"
      },
      "project" : {
        "id" : 35138974,
        "identifier" : "5192de5eb435430c8cd41c6ae6028848",
        "name" : "DevOps Full-Process Sample Project XXXX",
        "type" : "scrum"
      },
      "path" : "886637",
      "path_name" : "Asada"
    }
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK (The request has succeeded).

Error Codes

See Error Codes.