bimserver-project服务
服务概述
项目服务为用户的工作及协同提供以项目为单位的独立工作空间，保证不同项目之间的资源和业务隔离，具体包含如下功能：
1，项目的增、删、改以及成员数量和空间大小等详细信息的查询；
2，项目成员的增、删、改、查以及批量操作；
3，项目成员分组，并支持分组之间的层级关系，满足项目内的人员管理需求。
项目组管理
1.在指定项目组下创建一个子项目组
POST /bimserver/project/v3/projects/{projectId}/parent/{parentId}/group
在groupId为父Id下创建组
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| parentId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
SimpleGroupModelDataWrapper |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
Not Found |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/parent/{parentId}/group
请求体
Group对象元数据，用于新增Group
类型: application/json
引用模型:GroupMetadata
请求体示例
{
"name": "string",
"userData": "string"
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| name |
string |
是 |
Group 的名字 |
| userData |
string |
否 |
Group 的用户数据 |
HTTP响应示例
响应200
{
"data": {
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: SimpleGroupModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
2.从项目中删除指定的项目组
DELETE /bimserver/project/v3/projects/{projectId}/groups/{groupId}
通过 ProjectId删除指定的 ProjectGroup
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ResponseEntity |
| 204 |
No Content |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}
HTTP响应示例
响应200
{
"body": {},
"statusCode": "string",
"statusCodeValue": 0
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| body |
object |
否 |
None |
| statusCode |
string |
否 |
None |
| statusCodeValue |
integer |
否 |
None |
3.获取指定项目下的全部项目组
GET /bimserver/project/v3/projects/{projectId}/groups
通过ProjectId获取当前 Project 下的全部 Group
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
SimpleGroupModelPaging |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
NOT_FOUND |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«SimpleGroupModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
4.获取指定父项目组下的全部子项目组
GET /bimserver/project/v3/projects/{projectId}/parent/{parentId}/groups
获取具有相同 parentId 的 Group
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| parentId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
SimpleGroupModelPaging |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
Not Found |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/parent/{parentId}/groups
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«SimpleGroupModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
5.查询指定的项目组信息
GET /bimserver/project/v3/projects/{projectId}/groups/{groupId}
获取 groupId 对应的 Group
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
SimpleGroupModelDataWrapper |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
NOT_FOUND |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}
HTTP响应示例
响应200
{
"data": {
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: SimpleGroupModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
6.更新指定项目组信息
PUT /bimserver/project/v3/projects/{projectId}/groups/{groupId}
更新 ProjectGroup 信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
SimpleGroupModelDataWrapper |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}
请求体
用于更新 Group 的对象
类型: application/json
引用模型:GroupMetadataForUpdate
请求体示例
{
"name": "string",
"parentId": "string",
"userData": "string"
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| name |
string |
否 |
Group 的名字 |
| parentId |
string |
否 |
Group 的父 Group 的 Id |
| userData |
string |
否 |
Group 的用户数据 |
HTTP响应示例
响应200
{
"data": {
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: SimpleGroupModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
项目管理
7.创建一个新的项目
POST /bimserver/project/v3/projects
创建一个新的 Project
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectModelDataWrapper |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects
请求体
Project对象元数据
类型: application/json
引用模型:ProjectMetadata
请求体示例
{
"address": "string",
"avatar_link": "string",
"city": "string",
"country": "string",
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"originCurrentSfsSize": 1.0,
"owner": "string",
"projectAdmin": "string",
"province": "string",
"size": "string",
"tag": "string",
"type": "string",
"user_data": "string"
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| address |
string |
否 |
地址:详细地址 |
| avatar_link |
string |
是 |
Project 的头像链接地址 |
| city |
string |
否 |
地址:市 |
| country |
string |
否 |
地址:国家 |
| cycle |
string |
否 |
项目周期 |
| description |
string |
否 |
Project 的描述 |
| district |
string |
否 |
地址:区 |
| external_id |
string |
否 |
Project 关联的一个外部系统ID，方便系统间的相互关联。 |
| max_member_count |
integer |
是 |
Project 的最大成员数量 |
| max_storage_size |
number |
是 |
Project 的最大存储空间大小，单位为GB |
| name |
string |
是 |
Project 名称 |
| originCurrentSfsSize |
number |
是 |
项目的已用存储大小 |
| owner |
string |
是 |
Project 的所有者 |
| projectAdmin |
string |
否 |
项目管理员 |
| province |
string |
否 |
地址:省 |
| size |
string |
否 |
项目规模 |
| tag |
string |
否 |
用户可以使用此 tag 关联外部的唯一标识,对 Project 进行分类。 |
| type |
string |
否 |
项目类型 |
| user_data |
string |
否 |
用户自定义的数据，用于保存一些少量的扩展数据。 |
HTTP响应示例
响应200
{
"data": {
"active": true,
"address": "string",
"avatar_link": "string",
"city": "string",
"client_id": "string",
"country": "string",
"create_at": 1577808000000,
"current_member_count": 0,
"current_sfs_size": 0,
"current_storage_size": 0,
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"id": "string",
"isJoined": true,
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"owner": "string",
"projectClass": "string",
"province": "string",
"size": "string",
"tag": "string",
"thumbnail": "string",
"type": "string",
"update_at": 1577808000000,
"user_data": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: ProjectModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
8.删除指定的项目
DELETE /bimserver/project/v3/projects/{projectId}
通过ProjectId从数据库删除 Project
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ResponseEntity |
| 204 |
No Content |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}
HTTP响应示例
响应200
{
"body": {},
"statusCode": "string",
"statusCodeValue": 0
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| body |
object |
否 |
None |
| statusCode |
string |
否 |
None |
| statusCodeValue |
integer |
否 |
None |
9.根据项目标签查询总项目配额（成员数量和存储容量）
POST /bimserver/project/v3/projects/quotas
获取 Project 中的 成员数量 和 存储空间大小
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectQuotasModelDataWrapper |
| 201 |
Created |
/ |
|
| 400 |
数据已经接收到，但是数据格式和语法有问题，服务无法处理，请检查发送的数据。 |
/ |
ExceptionModel |
| 401 |
Unauthorized |
/ |
|
| 403 |
Forbidden |
/ |
|
| 404 |
Not Found |
/ |
|
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/quotas
请求体
Tag 的集合
类型: application/json
引用模型:Items«string»
请求体示例
{
"items": [
"string"
]
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| items |
array |
是 |
对象的集合 |
HTTP响应示例
响应200
{
"data": {
"projectQuotas": [
{
"currentMemberCount": 0,
"currentSfsSize": 0,
"currentStorageSize": 0,
"maxMemberCount": 0,
"maxStorageSize": 1.0,
"projectClass": "string",
"projectId": "string",
"tag": "string"
}
]
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: ProjectQuotasModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
10.查询指定项目的配额（成员数量和存储容量）
GET /bimserver/project/v3/projects/{projectId}/quota
获取 Project 中的 成员数量 和 存储空间大小
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectQuotaModelDataWrapper |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/quota
HTTP响应示例
响应200
{
"data": {
"id": "string",
"memberCount": 0,
"sfsSize": 0,
"storageSize": 0,
"userIdsForProjectAdmin": [
"string"
]
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: ProjectQuotaModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
11.查询指定项目的详细信息
GET /bimserver/project/v3/projects/{projectId}
根据 ProjectId 获取一个 Project 的详细信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectModelDataWrapper |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}
HTTP响应示例
响应200
{
"data": {
"active": true,
"address": "string",
"avatar_link": "string",
"city": "string",
"client_id": "string",
"country": "string",
"create_at": 1577808000000,
"current_member_count": 0,
"current_sfs_size": 0,
"current_storage_size": 0,
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"id": "string",
"isJoined": true,
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"owner": "string",
"projectClass": "string",
"province": "string",
"size": "string",
"tag": "string",
"thumbnail": "string",
"type": "string",
"update_at": 1577808000000,
"user_data": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: ProjectModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
12.根据用户id获取其参与的项目详细信息
GET /bimserver/project/v3/projects/user/{userId}
根据 userId 获取其参与的 Project 的详细信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| tag |
query |
None |
否 |
创建 Project 时设置的tag,当tag为null或空时,查询userId所有的参与的Project |
| userId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectModelPaging |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/user/{userId}?tag=xxx
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"address": "string",
"avatar_link": "string",
"city": "string",
"client_id": "string",
"country": "string",
"create_at": 1577808000000,
"current_member_count": 0,
"current_sfs_size": 0,
"current_storage_size": 0,
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"id": "string",
"isJoined": true,
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"owner": "string",
"projectClass": "string",
"province": "string",
"size": "string",
"tag": "string",
"thumbnail": "string",
"type": "string",
"update_at": 1577808000000,
"user_data": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«ProjectModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
13.分页获取所有符合查询条件的项目
GET /bimserver/project/v3/projects
列举出所有的 Project(分页模式)
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| tag |
query |
None |
否 |
Tag |
| order |
query |
None |
否 |
排序的字段。name(,ASC |
| pageNumber |
query |
None |
否 |
pageNumber |
| pageSize |
query |
None |
否 |
pageSize |
| projectName |
query |
None |
否 |
项目名称 |
| tags |
query |
None |
否 |
Tag 的集合 |
| projectClass |
query |
None |
否 |
默认为bimbox_project类型 |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectModelPaging |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
NOT_FOUND |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects?tag=xxx&order=xxx&pageNumber=xxx&pageSize=xxx&projectName=xxx&tags=xxx&projectClass=xxx
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"address": "string",
"avatar_link": "string",
"city": "string",
"client_id": "string",
"country": "string",
"create_at": 1577808000000,
"current_member_count": 0,
"current_sfs_size": 0,
"current_storage_size": 0,
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"id": "string",
"isJoined": true,
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"owner": "string",
"projectClass": "string",
"province": "string",
"size": "string",
"tag": "string",
"thumbnail": "string",
"type": "string",
"update_at": 1577808000000,
"user_data": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«ProjectModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
14.更新指定项目的状态
PUT /bimserver/project/v3/projects/{projectId}/state
更新 Project 状态
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectModelDataWrapper |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/state
请求体
Project将要被更新的状态
类型: application/json
引用模型:ActiveModel
请求体示例
{
"active": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| active |
boolean |
否 |
状态 |
HTTP响应示例
响应200
{
"data": {
"active": true,
"address": "string",
"avatar_link": "string",
"city": "string",
"client_id": "string",
"country": "string",
"create_at": 1577808000000,
"current_member_count": 0,
"current_sfs_size": 0,
"current_storage_size": 0,
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"id": "string",
"isJoined": true,
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"owner": "string",
"projectClass": "string",
"province": "string",
"size": "string",
"tag": "string",
"thumbnail": "string",
"type": "string",
"update_at": 1577808000000,
"user_data": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: ProjectModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
15.更新指定项目的信息
PUT /bimserver/project/v3/projects/{projectId}
更新 projectId 对应的 Project 信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ProjectModelDataWrapper |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}
请求体
需要更新的 Project 元数据。例如名称和自定义数据等。
类型: application/json
引用模型:ProjectMetadata
请求体示例
{
"address": "string",
"avatar_link": "string",
"city": "string",
"country": "string",
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"originCurrentSfsSize": 1.0,
"owner": "string",
"projectAdmin": "string",
"province": "string",
"size": "string",
"tag": "string",
"type": "string",
"user_data": "string"
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| address |
string |
否 |
地址:详细地址 |
| avatar_link |
string |
是 |
Project 的头像链接地址 |
| city |
string |
否 |
地址:市 |
| country |
string |
否 |
地址:国家 |
| cycle |
string |
否 |
项目周期 |
| description |
string |
否 |
Project 的描述 |
| district |
string |
否 |
地址:区 |
| external_id |
string |
否 |
Project 关联的一个外部系统ID，方便系统间的相互关联。 |
| max_member_count |
integer |
是 |
Project 的最大成员数量 |
| max_storage_size |
number |
是 |
Project 的最大存储空间大小，单位为GB |
| name |
string |
是 |
Project 名称 |
| originCurrentSfsSize |
number |
是 |
项目的已用存储大小 |
| owner |
string |
是 |
Project 的所有者 |
| projectAdmin |
string |
否 |
项目管理员 |
| province |
string |
否 |
地址:省 |
| size |
string |
否 |
项目规模 |
| tag |
string |
否 |
用户可以使用此 tag 关联外部的唯一标识,对 Project 进行分类。 |
| type |
string |
否 |
项目类型 |
| user_data |
string |
否 |
用户自定义的数据，用于保存一些少量的扩展数据。 |
HTTP响应示例
响应200
{
"data": {
"active": true,
"address": "string",
"avatar_link": "string",
"city": "string",
"client_id": "string",
"country": "string",
"create_at": 1577808000000,
"current_member_count": 0,
"current_sfs_size": 0,
"current_storage_size": 0,
"cycle": "string",
"description": "string",
"district": "string",
"external_id": "string",
"id": "string",
"isJoined": true,
"max_member_count": 0,
"max_storage_size": 1.0,
"name": "string",
"owner": "string",
"projectClass": "string",
"province": "string",
"size": "string",
"tag": "string",
"thumbnail": "string",
"type": "string",
"update_at": 1577808000000,
"user_data": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: ProjectModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
项目成员管理
16.添加成员到一个指定的项目
POST /bimserver/project/v3/projects/{projectId}/members
添加 Member 到对应的 Project，默认忽略冲突，即重复添加成员不会报错
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
Not Found |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members
请求体
新增 Member 的必要参数
类型: application/json
引用模型:MemberMetadataForCreate
请求体示例
{
"ignoreConflict": true,
"memberDataList": [
{
"active": true,
"realName": "string",
"tag": "string",
"userData": "string",
"userId": "string"
}
]
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| ignoreConflict |
boolean |
否 |
ignoreConflict 为 true 时,重复添加不会报错,为 false 时,检查重复添加返回异常,默认为 true,正常状态时返回参数中对应的条目的ProjectMember对象模型 |
| memberDataList |
array |
是 |
创建 Member 的必要数据的一个列表 |
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
17.批量删除指定项目的项目成员
DELETE /bimserver/project/v3/projects/{projectId}/members/batch
批量删除项目成员通过ProjectId
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ResponseEntity |
| 204 |
No Content |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members/batch
请求体
批量删除项目成员元数据
类型: /
引用模型:MemberIdsMetadata
请求体示例
{
"memberIds": [
"string"
]
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| memberIds |
array |
是 |
项目成员ID集合元数据 |
HTTP响应示例
响应200
{
"body": {},
"statusCode": "string",
"statusCodeValue": 0
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| body |
object |
否 |
None |
| statusCode |
string |
否 |
None |
| statusCodeValue |
integer |
否 |
None |
18.从项目中删除指定的项目成员
DELETE /bimserver/project/v3/projects/{projectId}/members/{memberId}
通过MemberId删除指定的 ProjectMember
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| memberId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
ResponseEntity |
| 204 |
No Content |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members/{memberId}
HTTP响应示例
响应200
{
"body": {},
"statusCode": "string",
"statusCodeValue": 0
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| body |
object |
否 |
None |
| statusCode |
string |
否 |
None |
| statusCodeValue |
integer |
否 |
None |
19.通过用户id获取对应的项目成员信息
GET /bimserver/project/v3/projects/{projectId}/members/user/{userId}
通过 userId 获取对应的 ProjectMember
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| userId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelDataWrapper |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
NOT_FOUND |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members/user/{userId}
HTTP响应示例
响应200
{
"data": {
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: MemberModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
20.根据成员id获取指定项目成员信息
GET /bimserver/project/v3/projects/{projectId}/members/{memberId}
通过memberId获取 ProjectMember 信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| memberId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelDataWrapper |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members/{memberId}
HTTP响应示例
响应200
{
"data": {
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: MemberModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
21.分页获取指定项目的所有成员信息
GET /bimserver/project/v3/projects/{projectId}/members
获取 Project 的全部 ProjectMember
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| pageNumber |
query |
None |
否 |
pageNumber |
| pageSize |
query |
None |
否 |
pageSize |
| projectId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members?pageNumber=xxx&pageSize=xxx
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
22.更新指定项目成员的状态
PUT /bimserver/project/v3/projects/{projectId}/members/{memberId}/state
更新指定项目成员的状态，使用activeModel标识一个对象的状态
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| memberId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelDataWrapper |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members/{memberId}/state
请求体
对象的状态
类型: application/json
引用模型:ActiveModel
请求体示例
{
"active": true
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| active |
boolean |
否 |
状态 |
HTTP响应示例
响应200
{
"data": {
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: MemberModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
23.更新指定项目成员的信息
PUT /bimserver/project/v3/projects/{projectId}/members/{memberId}
更新指定项目成员的信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| memberId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelDataWrapper |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/members/{memberId}
请求体
用于更新 Member 的对象
类型: application/json
引用模型:MemberMetadataForUpdate
请求体示例
{
"tag": "string",
"userData": "string"
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| tag |
string |
否 |
项目成员的标签tag |
| userData |
string |
否 |
项目成员的用户数据 |
HTTP响应示例
响应200
{
"data": {
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
},
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: MemberModel |
否 |
None |
| x_ref |
object: Reference |
否 |
None |
项目组成员管理
24.分页获取一个项目组及其子分组下的所有成员信息
GET /bimserver/project/v3/projects/{projectId}/groups/{groupId}/all
分页获取一个分组及其子分组下的所有成员信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| pageNumber |
query |
None |
否 |
pageNumber |
| pageSize |
query |
None |
否 |
pageSize |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}/all?pageNumber=xxx&pageSize=xxx
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
25.获取指定项目组下的全部成员
GET /bimserver/project/v3/projects/{projectId}/groups/{groupId}/members/search
获取 Project 的全部 ProjectMember
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| searchParam |
query |
None |
是 |
查询参数(目前仅根据用户姓名查询) |
| order[] |
query |
None |
否 |
排序的字段。name:ASC |
| pageNumber |
query |
None |
否 |
|
| pageSize |
query |
None |
否 |
|
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}/members/search?searchParam=xxx&order[]=xxx&pageNumber=xxx&pageSize=xxx
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
26.分页获取指定项目组下的所有成员信息
GET /bimserver/project/v3/projects/{projectId}/groups/{groupId}/members
获取一个分组下的成员信息
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| pageNumber |
query |
None |
否 |
pageNumber |
| pageSize |
query |
None |
否 |
pageSize |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
NOT_FOUND |
/ |
|
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}/members?pageNumber=xxx&pageSize=xxx
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
27.移动/添加成员到新的项目组（支持同时操作多个成员）
PUT /bimserver/project/v3/projects/{projectId}/groups/{groupId}/members
移动/添加 Member 到新的分组;可同时操作多个 Member.
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
| 201 |
Created |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}/members
请求体
用于操作成员所属分组的对象
类型: application/json
引用模型:Group 与 Member 信息集合,用于批量处理 Member 到 Group 的相关操作
请求体示例
{
"add": true,
"groupMemberLists": [
{
"groupId": "string",
"memberIds": [
"string"
]
}
]
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| add |
boolean |
否 |
'添加'或'移动';'添加'时(值为true)向目标分组添加 Member,原分组还存在不会被删除;'移动'时(值为false))向目标分组添加 Member,同时删除原分组Member |
| groupMemberLists |
array |
否 |
被操作的 Member 的Id列表 |
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
28.移除当前项目组的成员（支持同时操作多个成员）
DELETE /bimserver/project/v3/projects/{projectId}/groups/{groupId}/members
移除当前 Group 的 Member;可同时操作多个 Member
授权
| 请求头 |
内容 |
| Authorization |
Bearer token |
请求参数
| 名称 |
位置 |
类型 |
是否必填 |
描述 |
| projectId |
path |
string |
是 |
todo |
| groupId |
path |
string |
是 |
todo |
响应消息
| HTTP状态码 |
原因 |
类型 |
引用模型 |
| 200 |
请求成功 |
/ |
MemberModelPaging |
| 204 |
No Content |
/ |
|
| 401 |
未授权，请检查Authorization的Header的Access Token是否设置正确 |
/ |
ExceptionModel |
| 403 |
无权访问请求的资源 |
/ |
ExceptionModel |
| 404 |
请求的资源不存在 |
/ |
ExceptionModel |
| 500 |
服务内部错误，请查看详细的错误原因 |
/ |
ExceptionModel |
HTTP请求示例
请求路径
https://api.cloud.pkpm.cn/bimserver/project/v3/projects/{projectId}/groups/{groupId}/members
请求体
成员id的集合
类型: /
引用模型:Items«string»
请求体示例
{
"items": [
"string"
]
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| items |
array |
是 |
对象的集合 |
HTTP响应示例
响应200
{
"data": {
"count": 0,
"items": [
{
"active": true,
"createAt": 1577808000000,
"groupModels": [
{
"createAt": 1577808000000,
"id": "string",
"name": "string",
"parentId": "string",
"projectId": "string",
"updateAt": 1577808000000,
"userData": "string"
}
],
"id": "string",
"projectId": "string",
"tag": "string",
"updateAt": 1577808000000,
"userData": "string",
"userId": "string"
}
]
},
"first": true,
"hasNext": true,
"hasPrevious": true,
"last": true,
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPage": 0,
"x_ref": {
"users": [
{
"address": "string",
"avatarLink": "string",
"birthDate": "string",
"cardSetting": "string",
"city": "string",
"company": "string",
"country": "string",
"createAt": "string",
"department": "string",
"displayName": "string",
"district": "string",
"education": "string",
"email": "string",
"employeeNumber": "string",
"enabled": true,
"gender": 0,
"notifySettings": [
"string"
],
"phoneNumber": "string",
"phoneNumberValidated": true,
"postcode": "string",
"professionCertificate": "string",
"province": "string",
"qqNumber": "string",
"realName": "string",
"remark": "string",
"resumes": [
{
"id": "string",
"previousPosition": "string",
"workYears": 0
}
],
"title": "string",
"titleCertificate": "string",
"updateAt": "string",
"userid": "string",
"username": "string",
"workTime": 1577808000000
}
]
}
}
字段说明
| 名称 |
类型 |
必填 |
描述 |
| data |
object: Items«MemberModel» |
否 |
None |
| first |
boolean |
否 |
None |
| hasNext |
boolean |
否 |
是否有下一页 |
| hasPrevious |
boolean |
否 |
是否有上一页 |
| last |
boolean |
否 |
None |
| pageNumber |
integer |
否 |
当前是第几页 |
| pageSize |
integer |
否 |
当前页的最大记录数 |
| totalElements |
integer |
否 |
内容总共有多少条 |
| totalPage |
integer |
否 |
总共有多少页 |
| x_ref |
object: Reference |
否 |
None |
