1. 编辑分享包

编辑分享包,编辑key为{key}的分享包。

请求方式:POST

请求地址:/bosdocumentservice/{appKey}/shares/{key}

1.1. 请求参数:

Headers:

参数名 类型 示例 是否必填 参数含义
Authorization string c4570cb9ca324bc8ba7dd9d1967710ea access_token

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key
key string sha-001 分享包Key

SearchParas:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.2. 请求主体:

application/json:

{
    "validTime": "",
    "delObjs": [
        {
            "bosclass": "documents",
            "key": "FLD-001"
        }
    ],
    "addObjs": [
        {
            "bosclass": "documents",
            "key": "FLD-001"
        }
    ]
"gdownload": true //是否允许下载 true/false
}

1.3. 参数说明:

参数名 类型 示例 是否必填 参数含义
NULL NULL NULL NULL NULL

1.4. 正确返回:

Http Status Code:200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": "http://bosgw.bimwinner.com/shares/sha-001"
}

1.5. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当{key}的share不存在时
200 ENTITY_WRITEPERMISSION_REQUIRED 缺少实体对象{entity/key}的写权限 NULL 当对分享包无写权限时
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当添加的对象不存在时
200 ENTITY_CONTROLPERMISSION_REQUIRED 缺少实体对象{bosclass/ke}的控制权限 NULL 当添加的对象无控制权限时
200 RELATIONSHIP_BYFROMTO_NOTFOUND 左对象为{bosclass/key}、右对象为{bosclass/key} NULL 指定分享包中不包含指定的对象

1.6. 注意事项:

1、 只能编辑分享包 名称、有效时间、分享对象、接受人、下载权限。

2、 delObjs里的对象必须已经在分享对象里面。

3、 addObjs 里的对象必须存在。

4、编辑后,objects不能为空。

版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""