文档WorkfrontWorkfront 指南

通过文档Webhook上传文件

2025年4月25日
  • 主题:

创建对象:

  • 开发人员

将文件上传到文档存储提供商的过程分为两步,需要两个单独的API端点。 Adobe Workfront通过调用/uploadInit开始上传过程。 此端点返回一个文档ID,然后在上传文档字节时将其传递到/upload。 根据基础文档存储系统的不同,可能需要创建一个长度为零的文档,然后稍后更新该文档的内容。

添加到此规范版本1.1中的文档ID和文档版本ID可用于从Workfront中检索额外信息。

示例: ​如果文档管理系统需要有关文档的额外信息,webhook实现代码可以使用文档ID使用Workfront的RESTful API检索该信息。 好的做法是,这些信息可能来自文档上的自定义数据字段,并且包含任务、问题或项目。

POST方法

URL

POST /uploadInit

查询参数

名称描述
parentId由webhook提供程序引用的父文件夹ID。
文件名文档的名称
documentIdWorkfront文档ID(1.1版中添加)
documentVersionIdWorkfront文档版本ID(在版本1.1中添加)

响应

文件的元数据,由/metadata端点定义。 这包括提供商使用的文档ID。

示例:

https://www.acme.com/api/uploadInit?parentId=12345&filename=new-file.png&documentId=511ea6e000023edb38d2effb2f4e6e3b&documentVersionId=511ea6e000023edb38d2e ffb2f4e6e3b

PUT方法

将文档的字节上载到webhook提供程序。

URL

PUT /upload

查询参数

名称描述
id刚刚创建的文档ID。

请求正文

文档的原始内容字节。

响应

{
result: "success"
}

或

{
result: "fail"
}

示例

https://www.acme.com/api/upload?id=1234 [document bytes included in update stream]

响应

{
result:"success"
}
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43