文档

GetMaterialById - 获取素材明细

更新时间:
一键部署

获取素材明细。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AgentKeystring

业务空间唯一标识:AgentKey

67c520d1fa43455ea44fb69fa402d54d_p_beebot_public
Idlong

任务主键 ID

60

返回参数

名称类型描述示例值
object

PlainResult

RequestIdstring

请求唯一标识

3f7045e099474ba28ceca1b4eb6d6e21
Successboolean

是否成功:true 成功,false 失败

false
Codestring

状态码

DataNotExists
Messagestring

错误说明

数据不存在
HttpStatusCodeinteger

http 状态码

200
Dataobject

业务数据

Idlong

主键

32
DocTypestring

文档类型,pdf、word、url、image

pdf
Titlestring

文档标题

文档标题
Summarystring

文档摘要

文档摘要
Authorstring

作者

文档作者
PubTimestring

发布时间

2023-04-11 06:14:07
DocKeywordsarray

文档标签用于分类等、不同 keyword 之间逗号分割

string

关键词

关键词
Urlstring

内部文档保存的 URL

https://www.example.com
PublicUrlstring

临时的对外公开的 URL

https://www.example.com
ExternalUrlstring

外部客户上传的 URL,仅用作记录保存

https://www.example.com
SrcFromstring

文档来源,user_upload、search、viewpoint

user_upload
TextContentstring

解析后的文本内容,对于图片来说为空

文本内容
HtmlContentstring

网页内容

网页内容
ShareAttrinteger

公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享

1
CreateTimestring

创建时间

2023-03-21 11:34:19
UpdateTimestring

修改时间

2022-04-08 19:33:01
CreateUserstring

创建用户 ID

1
UpdateUserstring

修改用户 ID

1
ThumbnailInBase64string

图片文档类型的 Base64 缩略图

Base64编码的缩略图

示例

正常返回示例

JSON格式

{
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Success": false,
  "Code": "DataNotExists",
  "Message": "数据不存在",
  "HttpStatusCode": 200,
  "Data": {
    "Id": 32,
    "DocType": "pdf",
    "Title": "文档标题",
    "Summary": "文档摘要",
    "Author": "文档作者",
    "PubTime": "2023-04-11 06:14:07\n",
    "DocKeywords": [
      "关键词"
    ],
    "Url": "https://www.example.com",
    "PublicUrl": "https://www.example.com\n",
    "ExternalUrl": "https://www.example.com\n",
    "SrcFrom": "user_upload",
    "TextContent": "文本内容",
    "HtmlContent": "网页内容",
    "ShareAttr": 1,
    "CreateTime": "2023-03-21 11:34:19",
    "UpdateTime": "2022-04-08 19:33:01",
    "CreateUser": "1",
    "UpdateUser": "1",
    "ThumbnailInBase64": "Base64编码的缩略图"
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈