跳转到内容

模块

软件模块管理 - 面向模块化系统架构设计的API接口,支持创建和组织独立功能单元


导入模块示例

POST
/api/v1/module/example/import

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询项目的软件模块详情

GET
/api/v1/module/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

模块ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

全文检索项目的软件模块树

GET
/api/v1/module/tree/search
UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
Parent module ID
类型integer
format"int64"
name
类型string
sequence
类型integer
format"int32"
createdDate
类型string
format"date-time"
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

成功

*/*
JSON
"string"
授权
变量
cURL
JavaScript
PHP
Python

全文检索项目中的软件模块

GET
/api/v1/module/search
UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
Parent module ID
类型integer
format"int64"
name
类型string
sequence
类型integer
format"int32"
createdDate
类型string
format"date-time"
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

成功

*/*
JSON
"string"
授权
变量
cURL
JavaScript
PHP
Python

查询项目的软件模块树

GET
/api/v1/module/tree

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
name
类型string
Parent module ID
类型integer
format"int64"
sequence
类型integer
format"int32"
createdDate
类型string
format"date-time"
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询项目的软件模块列表

GET
/api/v1/module

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
name
类型string
Parent module ID
类型integer
format"int64"
sequence
类型integer
format"int32"
createdDate
类型string
format"date-time"
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换项目的软件模块

PUT
/api/v1/module

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

添加项目的软件模块

POST
/api/v1/module

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

删除项目的软件模块

DELETE
/api/v1/module

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

用例模块ID

类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

更新项目的软件模块

PATCH
/api/v1/module

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
[
]

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布