Importación y exportación de datos con una API REST

Puede utilizar las API REST para exportar datos del sistema C a un sistema o aplicación externos y para importar datos de un sistema o aplicación externos en el sistema Gestionar . Puede exportar e importar archivos JSON, XML. o CSV.

Importación de datos

Para importar datos, debe elegir una estructura de objeto Gestionar que haga referencia a los objetos de negocio Gestionar que consumen los datos. Si utiliza un archivo CSV, debe seleccionar una estructura de objeto habilitada para archivos sin formato. Todas las estructuras de objeto que son para una API primaria están habilitadas para archivo sin formato.

La sintaxis se valida para los datos antes de que los datos se almacenen en un repositorio interno de Gestionar .

La tabla siguiente contiene ejemplos de importación de datos mediante APIs REST:

Tabla 1. Ejemplos de importación de datos
Caso de uso	Llamadas y respuestas de API REST
Los datos se importan síncronamente de un archivo CSV que contiene 10 registros	Se utiliza la llamada siguiente: `POST /maximo/api/os/object structure?action=importfile CSV file content` Se devuelve la respuesta siguiente: `{ “validdocs”:10 }`
Los datos de activo y planta se importan síncronamente de una matriz de archivos JSON	Se utiliza la llamada siguiente: `POST /maximo/api/os/object structure?action=importfile Filetype: JSON [ { “assetnum”:”asset number”, “siteid”:”site ID” }, { “assetnum”:”asset number”, “siteid”:”site ID” } ]`
Los datos se importan asíncronamente de un archivo CSV	Se utiliza la llamada siguiente: `POST /maximo/api/os/object structure?action=importfile&name=filename.csv&async=1 CSV file content`

Nota: Al realizar una exportación CSV que utiliza un atributo .notation o su alias, la salida estaba en minúsculas. Este problema se ha corregido ahora en Maximo® Manage 8.5 y la salida está ahora en mayúsculas.

La tarea cron APIFILEIMPORT recupera los datos importados y procesa el contenido. La tarea cron se ejecuta cada 30 minutos y puede configurar la frecuencia de ejecución de la tarea cron.

Después de importar los datos, se proporciona un URL de ubicación que contiene el estado de la tarea cron APIFILEIMPORT. Si se produce un error mientras la tarea cron procesa los datos, la respuesta al URL de ubicación se incorpora con un URL que se conecta a un archivo de errores que puede descargar. Una vez resuelto el error, vuelva a importar el archivo. Asegúrese de especificar un nombre nuevo para el parámetro de consulta name.

Si está utilizando un archivo JSON para habilitar esta respuesta de error, la cabecera de solicitud Filetype debe ser JSON.

La respuesta siguiente es un ejemplo de la respuesta al URL de ubicación cuando se produce un error. El tipo de archivo es JSON.


{
 "iscomplete": true,
 "totalcount": 3,
 "errcount": 1,
 "requser": "Username",
 "fileimportreqqueueid": 3,
 "format": "JSON",
 "errorfile": "http://host:port/maximo/api/fileimporterrfile/3",
 "_rowstamp": "1521573",
 "iscancelled": false,
 "reqdatetime": "2019-02-20T14:08:22-05:00",
 "name": "testloc3.json",
 "href": "http://host:port/maximo/api/os/mxapifileimportqueue/_dGVzdGxvYzMuanNvbg--",
 "pindex": 3,
 "osname": "MXAPIOPERLOC"
}

Exportación de datos

Si exporta datos mediante las API REST para una integración de máquina a máquina, debe crear una clave de API para el cliente externo.

El formato de archivo predeterminado para exportar datos es JSON.

Por ejemplo, la llamada de API REST siguiente exporta datos de activo, planta y ubicación de la estructura de objeto MXAPIASSET como un archivo CSV:

GET /api/os/mxapiasset?oslc.select=assetnum,siteid,status,location&oslc.pageSize=100&
oslc.where=status=”OPERATING”&_format=csv&apikey=API key

Para las aplicaciones basadas en roles de Maximo Manage , que se basan en la tecnología Graphite, las API REST se utilizan para exportar archivos sin formato, es decir, archivos CSV, desde cualquier tabla de interfaz de usuario. El proceso de exportación es asíncrono y escribe el contenido de la página de la tabla de interfaz de usuario por página en un grupo S3 o en el directorio global Infraestructura de integración de Maximo . A continuación, combina las páginas en un único archivo, que puede descargar.

Nota: Como administrador, puede configurar un montaje de reclamación de volumen persistente (PVC) para todos los pods de Maximo Manage y enlazarlo a la propiedad mxe.int.globaldir . O bien, debe configurar un grupo S3 para la exportación estableciendo el nombre de grupo en la propiedad mxe.cosfileexportbucketname . La URL S3, el acceso y la clave secreta se establecen utilizando las propiedades estándar S3 ; mxe.cossecretkey, mxe.cosaccesskey, y mxe.cosendpointuri. Si la propiedad mxe.int.globaldir o la propiedad mxe.cosfileexportbucketname no está establecida, la exportación de archivo no funciona como se esperaba.

Para obtener más información sobre las API REST Maximo Mobile, consulte API REST Maximo Mobile.