huawei-cloud-api-definitions-iDMEClassicAPI 0.1.20250214

{"base_path":"/","components":null,"consumes":"","definitions":{"QueryShareDocsResp":{"properties":{"data":{"description":"**参数解释:**\n\n请求数据。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","items":{"$ref":"#/definitions/StructuredDocShareViewDTO"},"type":"array"},"errors":{"$ref":"#/definitions/errors"},"result":{"$ref":"#/definitions/result"}},"type":"object"},"RDMParamVOQueryShareDocs":{"properties":{"applicationId":{"description":"**参数解释**:\n\n应用ID。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值**:\n\n不涉及。","type":"string"},"params":{"description":"**参数解释**:\n\n结构化文档ID。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"}},"type":"object"},"StructuredDocShareViewDTO":{"properties":{"authType":{"description":"**参数解释**:\n\n认证类型。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n- read:只读。\n- write:读写。\n\n**默认取值**:\n\n不涉及。","type":"string"},"className":{"description":"**参数解释:**\n\n类名。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"createTime":{"description":"**参数解释:**\n\n创建时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"creator":{"description":"**参数解释:**\n\n创建者。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"id":{"description":"**参数解释**:\n\n唯一标识。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"},"lastUpdateTime":{"description":"**参数解释:**\n\n最后更新时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"modifier":{"description":"**参数解释:**\n\n修改人。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"rdmDeleteFlag":{"description":"**参数解释:**\n\n软删除标识。\n\n**取值范围:**\n\n- 0:表示未删除。\n- 1:表示已删除。\n\n**默认取值:**\n\n0。","format":"int32","type":"integer"},"rdmExtensionType":{"description":"**参数解释:**\n\n扩展类型。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"rdmVersion":{"description":"**参数解释:**\n\n系统版本。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","format":"int32","type":"integer"},"shareUserId":{"description":"**参数解释**:\n\n被分享用户UserId。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\nall:表示所有人。\n\n**默认取值**:\n\n不涉及。","type":"string"},"shareUserName":{"description":"**参数解释**:\n\n分享用户名。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"},"sharedUserId":{"description":"**参数解释**:\n\n被分享用户UserId。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\nall:表示所有人。\n\n**默认取值**:\n\n不涉及。","type":"string"},"sharedUserName":{"description":"**参数解释**:\n\n被分享用户名。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\nall:表示所有人。\n\n**默认取值**:\n\n不涉及。","type":"string"},"structuredDoc":{"$ref":"#/definitions/StructuredDocView","description":"**参数解释**:\n\n结构化文档。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"**参数解释:**\n\n租户信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。"}},"type":"object"},"StructuredDocView":{"properties":{"className":{"description":"**参数解释:**\n\n类名。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":"Tenant","type":"string"},"clazz":{"description":"**参数解释:**\n\n类名。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":"PersistableModel","type":"string"},"createTime":{"description":"**参数解释:**\n\n创建时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":"2023-12-02T03:03:07.695+0000","type":"string"},"create_user_id":{"description":"**参数解释:**\n\n创建者ID。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"creator":{"description":"**参数解释:**\n\n创建者。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":"Tester XXX","type":"string"},"document_id":{"description":"**参数解释:**\n\nkooPage文档ID。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"id":{"description":"**参数解释:**\n\n唯一标识。\n\n**取值范围:**\n\n-9223372036854775808到9223372036854775807的整数。\n\n**默认取值:**\n\n不涉及。","example":"548451844855177216","type":"string"},"instance_id":{"description":"**参数解释:**\n\n实例ID。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"lastUpdateTime":{"description":"**参数解释:**\n\n最后更新时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":"2023-12-02T03:03:07.695+0000","type":"string"},"model_name":{"description":"**参数解释:**\n\n模型名称。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"modifier":{"description":"**参数解释:**\n\n修改人。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"organization_id":{"description":"**参数解释:**\n\n团队ID。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"parent_document_id":{"description":"**参数解释:**\n\n父文档ID。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"rdmDeleteFlag":{"description":"**参数解释:**\n\n软删除标识,参数值为0或1。\n\n**取值范围:**\n\n- 0:表示未删除。\n- 1:表示已删除。\n\n**默认取值:**\n\n不涉及。","example":0,"format":"int32","type":"integer"},"rdmExtensionType":{"description":"**参数解释:**\n\n扩展类型。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":"VersionModelBranchViewDTO","type":"string"},"rdmVersion":{"description":"**参数解释:**\n\n系统版本。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","example":1,"format":"int32","type":"integer"},"template_id":{"description":"**参数解释:**\n\n模板ID。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"**参数解释:**\n\n租户信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。"},"title":{"description":"**参数解释:**\n\n文档标题。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"},"type":{"description":"**参数解释:**\n\n文档类型。\n\n**取值范围:**\n\n- directory:目录。\n- pageDocument:Page文档。\n- boardDocument:Board文档。\n- mindDocument:Mind文档。\n- drawDocument:Draw文档。\n\n**默认取值:**\n\n不涉及。","type":"string"},"wiki_id":{"description":"**参数解释:**\n\n知识库ID。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","type":"string"}},"required":["type"],"type":"object"},"TenantViewDTO":{"properties":{"className":{"description":"**参数解释:**\n\n类名。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"Tenant","type":"string"},"code":{"description":"**参数解释:**\n\n租户编码。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"basicTenant","type":"string"},"createTime":{"description":"**参数解释:**\n\n创建时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"2023-12-02T03:03:07.695+0000","type":"string"},"creator":{"description":"**参数解释:**\n\n创建者。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"},"dataSource":{"description":"**参数解释:**\n\n租户使用的数据源名称。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"DefaultDataSource","type":"string"},"description":{"description":"**参数解释:**\n\n描述信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"默认租户","type":"string"},"disableFlag":{"description":"**参数解释:**\n\n失效标识。 \n\n**取值范围:**\n\n- true:失效。 \n- false:未失效。\n\n**默认取值:**\n\nfalse。\n","example":false,"type":"boolean"},"id":{"description":"**参数解释:**\n\n唯一标识。 \n\n**取值范围:**\n\n-9223372036854775808到9223372036854775807的整数。\n\n**默认取值:**\n\n不涉及。\n","example":"-1","type":"string"},"kiaguid":{"description":"**参数解释:**\n\nKIA密级。 \n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","type":"string"},"lastUpdateTime":{"description":"**参数解释:**\n\n最后更新时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","type":"string"},"modifier":{"description":"**参数解释:**\n\n修改人。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"},"name":{"description":"**参数解释:**\n\n中文名称。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"basicTenant","type":"string"},"rdmDeleteFlag":{"description":"**参数解释:**\n\n软删除标识。\n\n**取值范围:**\n\n- 0:表示未删除。\n- 1:表示已删除。\n\n**默认取值:**\n\n0。\n","example":0,"format":"int32","type":"integer"},"rdmExtensionType":{"description":"**参数解释:**\n\n扩展类型。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"Tenant","type":"string"},"rdmVersion":{"description":"**参数解释:**\n\n系统版本。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":1,"format":"int32","type":"integer"},"securityLevel":{"description":"**参数解释:**\n\n安全密级。\n\n**取值范围:**\n\n- INTERNAL:内部公开。\n- SECRET:秘密。\n- CONFIDENTIAL:机密。\n- TOP_SECRET:绝密。\n\n**默认取值:**\n\n不涉及。\n","example":"INTERNAL","type":"string"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"**参数解释:**\n\n租户信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"}},"required":["code","dataSource"],"type":"object"},"errors":{"description":"**参数解释:**\n\n异常信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":[],"items":{"type":"string"},"type":"array"},"result":{"description":"**参数解释:**\n\n请求结果。\n\n**取值范围:**\n\n- SUCCESS:请求成功。\n- FAIL:请求失败。\n\n**默认取值:**\n\n不涉及。\n","example":"SUCCESS","type":"string"}},"description":null,"group_id":"ab5eda63b51647d6a950ceef4eccd859","host":"dme.cn-north-4.huaweicloud.com","id":"4d50f08b33aa4c1b882ef1ca05315290","info_version":"v1","method":"post","name":"ListQueryShareDocs","parameters":{"X-Auth-Token":{"description":"**参数解释:**\n\nIAM用户的token。\n\n获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。\n\n**约束限制:**  \n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**  \n\n不涉及。\n","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},"identifier":{"description":"**参数解释:**\n\n应用唯一标识。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值:**\n\n不涉及。\n","in":"path","name":"identifier","required":true,"type":"string","x-example":"b3f9b7523a6141f4b2d76b92d6595281"}},"paths":{"/rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc":{"post":{"consumes":["application/json"],"description":"查询结构化文档分享授权列表。","operationId":"ListQueryShareDocs","parameters":[{"description":"**参数解释:**\n\n数据模型的英文名称。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。\n\n**默认取值:**\n\n不涉及。","in":"path","name":"modelName","required":true,"type":"string","x-example":"StructuredDocableModel"},{"$ref":"#/parameters/identifier"},{"$ref":"#/parameters/X-Auth-Token"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RDMParamVOQueryShareDocs"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"data":[{"authType":"read","className":"StructuredDocShare","createTime":"2025-01-16T06:13:42.550+0000","creator":"XDM_Developer 93172bbfd0f64437956d4c9de9345386","id":"721366695490363392","lastUpdateTime":"2025-01-16T06:13:42.550+0000","modifier":"XDM_Developer 93172bbfd0f64437956d4c9de9345386","rdmDeleteFlag":0,"rdmExtensionType":"StructuredDocShare","rdmVersion":1,"shareUserId":"93172bbfd0f64437956d4c9de9345386","shareUserName":"XDM_Developer","sharedUserId":"all","sharedUserName":"all","structuredDoc":{"className":"StructuredDoc","createTime":"2025-01-15T07:25:51.668+0000","createUserId":"93172bbfd0f64437956d4c9de9345386","creator":"XDM_Developer 93172bbfd0f64437956d4c9de9345386","documentId":"d24cad08-c0b2-449d-9dce-924392b67bf8","id":"721022465261703168","instance":{"className":"StructuredDocableModel","clazz":"StructuredDocableModel","id":"1"},"lastUpdateTime":"2025-01-15T07:25:51.668+0000","modifier":"XDM_Developer 93172bbfd0f64437956d4c9de9345386","organizationId":"65cd6c5df4c84bdeb50dbfc7136cab7c","parentDocumentId":"a962e2d821c44bfdb65d33aa429c930uatwiki","rdmDeleteFlag":0,"rdmExtensionType":"StructuredDoc","rdmVersion":1,"templateId":null,"tenant":{"className":"Tenant","code":"basicTenant","createTime":"2024-11-13T08:27:59.903+0000","creator":"xdmAdmin","dataSource":"DefaultDataSource","description":"默认租户","disableFlag":false,"id":"-1","kiaguid":null,"lastUpdateTime":"2024-11-13T08:27:59.903+0000","modifier":"xdmAdmin","name":"basicTenant","nameEn":null,"rdmDeleteFlag":0,"rdmExtensionType":"Tenant","rdmVersion":1,"securityLevel":"internal","tenant":null},"title":"myTitle","type":"pageDocument","wikiId":"a962e2d821c44bfdb65d33aa429c930uatwiki"},"tenant":{"className":"Tenant","code":"basicTenant","createTime":"2024-11-13T08:27:59.903+0000","creator":"xdmAdmin","dataSource":"DefaultDataSource","description":"默认租户","disableFlag":false,"id":"-1","kiaguid":null,"lastUpdateTime":"2024-11-13T08:27:59.903+0000","modifier":"xdmAdmin","name":"basicTenant","nameEn":null,"rdmDeleteFlag":0,"rdmExtensionType":"Tenant","rdmVersion":1,"securityLevel":"internal","tenant":null}}],"errors":[],"result":"SUCCESS"}},"schema":{"$ref":"#/definitions/QueryShareDocsResp"}}},"summary":"查询结构化文档分享授权列表","tags":["结构化文档管理"],"x-constraint":"功能列表勾选了结构化文档管理的模型可以使用该接口。","x-is-registered":"Y","x-request-examples-1":{"params":"721022465261703168"},"x-request-examples-text-1":{"params":"721022465261703168"},"x-request-examples-url-1":"POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/StructuredDocableModel/structured-doc/share-doc","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"iDMEClassicAPI","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询结构化文档分享授权列表","tags":"结构化文档管理","uri":null,"version":"2.0"}