项目管理API
获取项目列表
接口地址
POST /api/v1.0/invoke/open-ability/method/manager-commands
请求参数
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 内容类型，值为application/json |
| Accept | String | Header | 是 | 接受类型，值为application/json |
| Authorization | String | Header | 是 | Bearer认证，访问令牌 |
| command | String | Body | 是 | 命令名称 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令参数 |
param说明
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| page_size | Integer | Body | 是 | 每页数量 |
| page_index | Integer | Body | 是 | 当前页数 |
返回参数
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| Content-Type | String | Header | 内容类型，值为application/json |
| success | Boolean | Body | 判断请求是否成功 true：成功 false：失败 |
| timestamp | Integer | Body | 时间戳 |
| result | []Object<result> | Body | 返回结果 |
result说明
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| project_id | String | Body | 项目ID |
| project_name | String | Body | 项目名称 |
请求示例
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_project_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"page_size": 1,
"page_index": 1
}
}
成功返回示例
状态码：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"project_id": "pfa332e258aae1badbb27d31128f442d1",
"project_name": "test"
}
]
}
失败返回示例
见 接口失败返回
获取项目信息
接口地址
POST /api/v1.0/invoke/open-ability/method/manager-commands
请求参数
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 内容类型，值为application/json |
| Accept | String | Header | 是 | 接受类型，值为application/json |
| Authorization | String | Header | 是 | Bearer认证，访问令牌 |
| command | String | Body | 是 | 命令名称 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令参数 |
param说明
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| project_id | String | Body | 是 | 项目ID |
返回参数
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| Content-Type | String | Header | 内容类型，值为application/json |
| success | Boolean | Body | 判断请求是否成功 true：成功 false：失败 |
| timestamp | Integer | Body | 时间戳 |
| result | Object<result> | Body | 返回结果 |
result说明
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| project_name | String | Body | 项目名称 |
请求示例
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_project_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
}
}
成功返回示例
状态码：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {
"project_name": "test"
}
}
失败返回示例
见 接口失败返回
获取导入结果
接口地址
POST /api/v1.0/invoke/open-ability/method/manager-commands
请求参数
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 内容类型，值为application/json |
| Accept | String | Header | 是 | 接受类型，值为application/json |
| Authorization | String | Header | 是 | Bearer认证，访问令牌 |
| command | String | Body | 是 | 命令名称 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令参数 |
param说明
| 参数名 | 类型 | 位置 | 必填 | 说明 |
|---|---|---|---|---|
| project_id | String | Body | 是 | 项目ID |
| import_type | String | Body | 是 | 导入类型 user_info：用户信息 user_pin_code_and_rf_card_access_info：用户PIN码与射频卡权限信息 user_face_access_info：用户人脸权限信息 staff_access_info：员工权限信息 |
| task_id | String | Body | 是 | 任务ID |
返回参数
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| Content-Type | String | Header | 内容类型，值为application/json |
| success | Boolean | Body | 判断请求是否成功 true：成功 false：失败 |
| timestamp | Integer | Body | 时间戳 |
| result | Object<result> | Body | 返回结果 |
result说明
| 参数名 | 类型 | 位置 | 说明 |
|---|---|---|---|
| created_time | String | Body | 创建时间，UTC |
| file_name | String | Body | 文件名称 |
| import_process | Integer | Body | 导入进度（%） |
| failure_count | Integer | Body | 失败数量 |
| is_resolved | Boolean | Body | 判断任务是否解决 true：已解决 false：未解决 |
| import_status | String | Body | 导入状态 not_resolved：未处理 success：成功 partial_failure：部分失败 importing：导入中 failure：失败 |
请求示例
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_import_result",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"import_type": "user_info",
"task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
}
}
成功返回示例
状态码：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {
"created_time": "2024-07-23 17:12:53",
"file_name": "test",
"import_process": 100,
"failure_count": 0,
"is_resolved": true,
"import_status": "success"
}
}
失败返回示例
见 接口失败返回