Carga de archivos mediante webhooks de documentos
Creado para:
- Desarrollador
La carga de un archivo a un proveedor de almacenamiento de documentos es un proceso de dos pasos que requiere dos puntos finales de API independientes. Adobe Workfront inicia el proceso de carga llamando a /uploadInit Este punto final devuelve un ID de documento que luego se pasa a /upload al cargar los bytes del documento. Según el sistema de almacenamiento de documentos subyacente, puede que sea necesario crear un documento de longitud cero y actualizar el contenido del documento más adelante.
Añadido a la versión 1.1 de esta especificación, el ID de documento y el ID de versión de documento se pueden utilizar para recuperar información adicional de Workfront.
Ejemplo: si el sistema de administración de documentos desea información adicional sobre el documento, el código de implementación del webhook podría utilizarr el ID del documento para recuperar esa información mediante la API RESTful de Workfront. Como práctica recomendada, esta información podría proceder de campos de datos personalizados del documento y contener tareas, problemas o proyectos.
Método POST
URL
POST /uploadInit
Parámetros de consulta
| Nombre | Descripción |
|---|---|
| parentId | ID de la carpeta principal, según la referencia del proveedor de webhooks. |
| filename | El nombre del documento |
| documentId | El ID del documento de Workfront (añadido en la versión 1.1) |
| documentVersionId | El ID de la versión del documento de Workfront (añadido en la versión 1.1) |
Respuesta
Los metadatos del archivo, tal como se definen en el punto final /metadata. Esto incluye el ID de documento utilizado por el proveedor.
Ejemplo:
https://www.acme.com/api/uploadInit?parentId=12345&filename=new-file.png&documentId=511ea6e000023edb38d2effb2f4e6e3b&documentVersionId=511ea6e000023edb38d2e ffb2f4e6e3b
Método PUT
Carga los bytes de un documento en el proveedor de webhooks.
URL
PUT /upload
Parámetros de consulta
| Nombre | Descripción |
|---|---|
| id | El identificador documento, que se acaba de crear. |
Cuerpo de solicitud
Los bytes de contenido sin procesar del documento.
Respuesta
{
result: "success"
}
o
{
result: "fail"
}
Ejemplo
https://www.acme.com/api/upload?id=1234 [document bytes included in update stream]
respuesta
{
result:"success"
}