ListFiles

Utilice este recurso para recuperar una lista de todos los archivos para una cuenta o de un rango de ellos.

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/ListFiles	Recupera una lista de todos o de un rango de archivos para la cuenta.

GET/scr/api/ListFiles

Descripción: Utilice este método para recuperar una lista de todos los archivos para la cuenta o de un rango de ellos.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	JSON
Requiere autenticación	Sí. El usuario debe ser un administrador para acceder a la API de ListFiles.
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

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
from	Consulta	Lista todos los archivos cargados después de esta fecha. La fecha se representa con los siguientes formatos de fecha ISO 8601: El formato largo es 2012-08-13T15:44:31.571-05:00. El formato corto es 2012-08-13. Las fechas en formato corto se supone que son a media noche de Hora estándar central (CST) de la fecha especificada. Por lo tanto, 2012-07-25 es lo mismo que 2012-07-25T00:00:00.000-05:00.	Nee	Formato de fecha ISO 8601

Respuesta

Entrada de ejemplo

Utilizando las credenciales de cliente OAuth 2:

curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/ListFiles?from=2012-08-13T15:37:01.887-05:00"

Resultado de ejemplo

{
  "files":[
    {
      "fileId":"b0050",
      "uploadUserId":"bob@foo.com",
      "uploadDate":"2012-08-13T15:37:08.770-05:00",
      "fileSize":591728,
      "fileName":"Earth.tif",
      "attachedToId":"b000f",
      "attachedToType":"process"
    }
  ]
}

Propiedades de respuesta

fileId: ID exclusivo del archivo. Utilice esta propiedad para llamar a FileDownload.
uploadUserId: ID de inicio de sesión o dirección de correo electrónico del usuario que ha subido el archivo.
uploadDate: Fecha en que se ha subido el archivo, en formato ISO 8601.
fileSize: Tamaño de archivo en bytes.
fileName: El nombre de archivo.
attachedToId: ID del proceso, publicación u otro elemento al que se adjunta el archivo.
attachedToType: Proceso, publicación u otro tipo de objeto al que se adjunta 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.