Module

Software Module Management - APIs for modular system architecture design, enabling creation and organization of independent functional units

---

Query the software module list of project

GET

/api/v1/module

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

name

类型string

Parent module ID

类型integer

format"int64"

sequence

类型integer

format"int32"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/module

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

Parent module ID

sequence

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Replace the software module of project

PUT

/api/v1/module

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 0,

"projectId": 0,

"Parent module ID": 1,

"sequence": 10000,

"Module name": "Sprint-1"

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/module

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add the software module of project

POST

/api/v1/module

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"Project id": 0,

"Parent module ID, null and -1 indicate that it is a top-level node": -1,

"sequence": 10000,

"Module name": [

"string"

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/module

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete the software modules of project

DELETE

/api/v1/module

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Case module ids

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/module

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update the software module of project

PATCH

/api/v1/module

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 0,

"Parent module ID": 1,

"sequence": 10000,

"Module name": "Sprint-1"

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/module

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Import the module example

POST

/api/v1/module/example/import

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/module/example/import

试验场

授权

UserHttpBearer

变量

键

值

projectId*

示例

cURL

JavaScript

PHP

Python

---

Query the software module detail of project

GET

/api/v1/module/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Module id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/module/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the software module tree of project

GET

/api/v1/module/tree

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

name

类型string

Parent module ID

类型integer

format"int64"

sequence

类型integer

format"int32"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/module/tree

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

Parent module ID

sequence

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the software module tree of project

GET

/api/v1/module/tree/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

Parent module ID

类型integer

format"int64"

name

类型string

sequence

类型integer

format"int32"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/module/tree/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

Parent module ID

name

sequence

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the software module of project

GET

/api/v1/module/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

format"int64"

projectId*

Project id

类型integer

必填

format"int64"

Parent module ID

类型integer

format"int64"

name

类型string

sequence

类型integer

format"int32"

createdDate

类型string

format"date-time"

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/module/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

Parent module ID

name

sequence

createdDate

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---