FileUpload

Utilice este recurso para añadir adjuntos a archivo para procesar actividades o elementos de trabajo.

Resumen del método

Método HTTP Vía de acceso Descripción
POST /scr/api/FileUpload Añade adjuntos a archivo para procesar actividades o elementos de trabajo.

POST/scr/api/FileUpload

Descripción
Utilice este método para añadir adjuntos a archivo para procesar actividades o elementos de trabajo.
Información de recursos
Requisitos Descripción
Formato de la respuesta JSON
Requiere autenticación Sí. El usuario debe tener acceso de autor al proceso al que se adjunta el archivo.
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de creación de artefactos
Velocidad limitada Aún no
Parámetros
Las entradas de locationField, ancestorIdField, parentIdField y fileData deben pasarse en formato de datos de diversos formularios y diversas partes estándar.
Nombre Ubicación Descripción Obligatorio Tipo
X-IBM-API-Version Cabecera La versión de la API a utilizar. El valor debe ser 20160630. Nee Serie
X-On-Behalf-Of Cabecera El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay. Necesario si se utilizan credenciales OAuth de ID de servicio. No es necesario cuando se utiliza la credencial OAuth de ID de servicio de usuario. Serie
fileData Consulta Datos del archivo. Sí RFC 1867 compatible con corriente de datos de diversos formularios o de diversas partes
locationField Consulta Según el objeto al que está conectado el archivo, los valores posibles son activity, app, decision, instance, policy o post. Sí Serie
ancestorIdField Consulta El significado depende del valor de locationField:
  • El ID de blueprint de proceso para un activity
  • El ID de aplicación de proceso para un app
  • El ID de diagrama de decisión para un decision
  • El ID de trabajo de una instancia existente para un instance
  • Para todos los demás valores de locationField, no es necesario que se proporcione este parámetro
 Sí Serie
parentIdField Consulta El significado depende del valor de locationField:
  • El ID de proceso para un activity
  • El ID de aplicación para un app
  • El ID de decisión para un decision
  • El ID de trabajo de una instancia existente para un instance
  • El ID de política para un policy
  • Este valor no tiene que proporcionarse para post
 Sí Serie
Respuesta
Resultado de ejemplo
{  
   "size":"3.0",
   "parentId":"",
   "uploadUserId":"7f0002",
   "fileItemId":"123b",
   "name":"testFileUpload",
   "ancestorId":"",
   "uploadDate":"1441217698308",
   "status":"SUCCESS",
   "isPublic":"false",
   "location":"instance",
   "uploadUserName":"admin",
   "version":"20160630",
   "type":"1",
   "id":"5f501e134978a"
}
Propiedades de respuesta
uploadUserId
ID del usuario que ha subido el archivo.
location
La ubicación a la que se ha subido el archivo.
status
El valor de la serie que indica el resultado del intento de carga. Los valores posibles incluyen:
SUCCESS
La operación se ha realizado satisfactoriamente.
FAILED
La carga ha fallado.
FAILED_DELETED
La carga ha fallado. Verifique que el archivo no contiene un virus e inténtelo de nuevo.
SIZE
La carga ha fallado porque el tamaño del archivo era mayor que 50 MB.
SPACE
La carga ha fallado porque la cuenta no tenía suficiente espacio disponible.
type
El tipo de archivo o documento con el valor numérico asociado.
Valor de tipo Descripción
1 Documento genérico. Se utiliza si el archivo no corresponde a ninguno de los otros valores.
2 Archivo de Microsoft Excel
3 Image
4 Documento PDF
5 Documento de Microsoft PowerPoint
6 Documento de Microsoft Project
7 Documento de Microsoft Visio
8 Documento de Microsoft Word
9 Archivo de texto
version
Versión de la API que se ha utilizado para crear la respuesta.
size
El tamaño del archivo subido en bytes.
id
ID del archivo subido. Utilice este ID con el servicio FileDownload para descargar el archivo.
parentId
ID del elemento padre al que se adjunta el archivo subido.
name
Nombre del archivo subido.
ancestorId
El ID del predecesor al que pertenece el archivo subido.
uploadDate
Fecha en que se ha subido el archivo. El valor se expresa en milisegundos desde el valor de época, que es el 1 de enero de 1970 a medianoche en Hora Universal Coordinada (UTC).
uploadUserName
Nombre del usuario que ha subido el archivo.
Mensajes de respuesta
Código HTTP Razón
200

La solicitud se ha completado correctamente.
401

El usuario no está autorizado a realizar la petición.
405 El método especificado no está permitido. Seleccione el método POST.