1. 获取文档信息

获取文档信息,获取key为{key}的文档信息。

请求方式:GET

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

1.1. 请求参数:

Headers:

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

PathParas:

参数名 类型 示例 是否必填 参数含义
appKey string xb05cd3a35614caa85c0f8f86c58fcc1 应用Key
key string 33a895949c2d4c27a0973b2a162b72a9 文档document key

SearchParas:

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

Body:

application/json:

NULL

1.2. 参数说明:

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

1.3. 正确返回:

Http Status Code:200
{
    "code": "SUCCESS",
    "message": "请求处理成功",
    "data": {
        "gLongCode": "",    //所属文件夹code路径
        "gLongName": ""    //所属文件夹name路径
    }
}

1.4. 状态码:

状态码 code message data 原因
200 ENTITY_NOTFOUND Key为{key}的{bosclass}实体对象不存在 NULL 当{key}的文档不存在时
200 ENTITY_READPERMISSION_REQUIRED 缺少实体对象{bosclass/key}的读权限 NULL 如{key}对应的文档无读权限

1.5. 注意事项:

1、前提需创建好文档。

2、同时返回gLongCode、gLongName,gLongCode代表文档所属文件夹key路径,依次由根文件夹到文档所属直接文件夹的key组成,中间用※分隔;gLongName代表文档所属文件夹name路径,依次由根文件夹到文档所属直接文件夹的name组成,中间用※分隔。

1.6. 请求示例

请求URL

http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/documents/5247e9572aae434abe56644d0ec5ad69

Headers

Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6InE4NWU4NTdhZWIwODQ1ZjE5YzBkY2QyYTQyNmUxMWUwIiwiYXBwTmFtZSI6InRlc3QxMTExMTEyMyIsImFwcERiIjoicTg1ZTg1N2FlYjA4NDVmMTljMGRjZDJhNDI2ZTExZTAiLCJsb2dpblRpbWUiOiIxNTk2Njk4MDAyMTA3IiwiZXhwIjowfQ.XsKFdpYnnH1lJ__u6x-4tvCnJ2BX7WfJ5EMGMAWfCe8

Body(application/json)

null

正常响应 200

{
    "message": "请求处理成功",
    "code": "SUCCESS",
    "data": {
        "parameter": {
            "bosclass": "documents",
            "code": "doc-001",
            "currentUserPermissions": "rwdc",
            "description": "test",
            "gacl": [
                {
                    "principal": "users/1527ffadaf8a4f4abae985c67bbd496d",
                    "permissions": "rwdc",
                    "flags": "",
                    "type": "A"
                }
            ],
            "gcreatetime": "1596793212441",
            "gtime": "1596793212441",
            "guser": "users/1527ffadaf8a4f4abae985c67bbd496d",
            "key": "5247e9572aae434abe56644d0ec5ad69",
            "name": "二维图纸",
            "revision": "0",
            "size": 20671267
        },
        "relationship": {
            "irDocumentFile": {
                "files": [
                    {
                        "code": "Z3JvdXAxMyxNNzgvMDQvMDQvckJBQUcxOHRJV1NBY0dLWkFUdHJJd0FwdzNnNTg5LmlmYw==",
                        "uri": "http://bosgw.bimwinner.com/bosfoundationservice/w8486e2a067e4bdab7630546ad01751a/prototype/entity/files/6ff47109865341dcb2cef982e0891b57",
                        "relationshipKey": "2fb3692d2db34b7ca2f7197f7d8d613e"
                    }
                ]
            }
        },
        "user": {
            "nativeUser": false,
            "registerTime": "1562145757298",
            "wxOpenID": "oEtfZwklSGF2HNUHSFK99J1DDAg0",
            "qqUUID": "w8486e2a067e4bdab7630546ad01751a※0.248655083513313※qq",
            "qqOpenID": "7AED55D536F493EBAA53D658133DBA2C",
            "fullName": "饶家俊",
            "active": "1",
            "telephone": "15702097950",
            "guserType": "0",
            "wxUUID": "o51ad8997e564373a33135d5a4689029※0.34153279984541296※wx",
            "lastLoginTime": "1596781283932",
            "wxUnionID": null,
            "qqUnionID": null,
            "name": "raojiajun",
            "company": "盈嘉内部员工123",
            "bosclass": "users",
            "userType": "1",
            "id": "1527ffadaf8a4f4abae985c67bbd496d",
            "email": "",
            "key": "1527ffadaf8a4f4abae985c67bbd496d"
        }
    }
}
版权所有@盈嘉互联(北京)科技有限公司 京ICP备15051988号-9 Copyright © 2022 all right reserved,powered by Gitbook该文件修订时间: 2022-05-16 19:01:04

results matching ""

    No results matching ""