FileDownload

Utilice este recurso para descargar un archivo adjunto a un proceso, una instancia o un comentario.

Nota: La documentación de la API se ha migrado a IBM API Hub El enlace externo abre una nueva ventana o pestaña

. Encuentre las últimas actualizaciones y documentación sobre Blueworks Live API en API Hub.

Resumen del método

Método HTTP	Vía de acceso	Descripción
GET	/scr/api/FileDownload	Descarga un archivo adjunto a un proceso, una instancia o un comentario.

GET/scr/api/FileDownload

Descripción: Utilice este método para descargar un archivo adjunto a un proceso, una instancia o un comentario.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	Datos sin formato del archivo en el mismo formato en que se ha subido.
Requiere autenticación	Sí. El usuario ha de tener por lo menos acceso al proceso, instancia o publicación al que está adjunto el archivo. Si un archivo está adjunto a una publicación que aún no se ha publicado o a una instancia que aún no se ha iniciado, el archivo solo podrá ser descargado por el usuario que lo haya subido.
Permite credenciales de cliente de OAuth 2	Sí, utilizando un ID de servicio de usuario que contiene la categoría de creación de informes de artefactos
Velocidad limitada	Aún no

Parámetros

El usuario debe proporcionar uno de los parámetros siguientes para especificar un objeto al que el archivo está adjunto:

processId
instanceId
postId

Si el archivo está adjunto a una publicación que no se ha publicado aún o a una instancia que todavía no se ha iniciado, el usuario no necesita proporcionar postId ni instanceId.

Nombre	Ubicación	Descripción	Obligatorio	Tipo
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 de ID de servicio OAuth. No es necesario cuando se utiliza la credencial de ID de servicio de usuario OAuth.	Serie
fileItemId	Consulta	ID del elemento de archivo a descargar. Este parámetro se devuelve como propiedad de la respuesta de `FileUpload`, `ProcessData`, `WorkDetail` o `AppDetail`. Para `FileUpload`, `WorkDetail` y `AppDetail`, el valor que se debe utilizar está en el campo `id`. Para `ProcessData`, el valor corresponde a la clave contenida en el diccionario `files`.	Sí	Serie
instanceId	Consulta	ID de la instancia a la que se adjunta el archivo.	Sí, si el archivo descargado está adjunto a una instancia.	Serie
postId	Consulta	ID de la publicación a la que se adjunta el archivo.	Sí, si el archivo descargado está adjunto a una publicación.	Serie
processId	Consulta	ID del proceso que contiene una actividad con el adjunto a archivo.	Sí, si el archivo descargado está adjunto a un proceso.	Serie

Respuesta

Datos del archivo.

Entrada de ejemplo

Uso de la ID de servicio de usuario OAuth 2 credenciales de cliente:

curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/FileDownload?fileItemId=9042b"

Uso de la ID de servicio OAuth 2 credenciales de cliente:

curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/FileDownload?fileItemId=9042b"

Uso de la ID de servicio OAuth 2 credenciales de cliente con contexto de usuario:

curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/FileDownload?fileItemId=9042b"

Resultado de ejemplo: Datos de archivos

Propiedades de respuesta: Ninguna

Mensajes de respuesta

Código HTTP	Razón
400	Solicitud incorrecta. Consulte el cuerpo de respuesta para obtener más información.
401	El usuario no está autorizado a realizar la petición.
403	El usuario no tiene acceso al proceso, instancia, o publicación al que está adjunto el archivo.