Importação e exportação de dados com a API de REST

Você pode usar APIs REST para exportar dados do seu sistema C em um sistema ou aplicativo externo e para importar dados de um sistema externo ou aplicativo em seu sistema Gerenciar . É possível exportar e importar arquivos JSON, XML ou CSV.

Importando Dados

Para importar dados, você deve escolher uma estrutura de objetos Gerenciar que referencia os objetos de negócios Gerenciar que consomem os dados. Se você usar um arquivo CSV, deverá selecionar uma estrutura de objeto que esteja ativada para arquivos simples. Todas as estruturas de objeto que forem para uma API primária serão ativadas para arquivo simples.

A sintaxe é validada para os dados antes que os dados sejam armazenados em um repositório interno Gerenciar .

A tabela a seguir contém exemplos de importação de dados usando APIs de REST:

Tabela 1. Exemplos de importação de dados
Caso de Uso	Chamadas e respostas da API de REST
Os dados são sincronicamente importados por meio de um arquivo CSV que contém 10 registros	A chamada a seguir é usada: `POST /maximo/api/os/object structure?action=importfile CSV file content` A resposta a seguir é retornada: `{ “validdocs”:10 }`
Os dados do ativo e do site são importados sincronicamente por meio de uma matriz de arquivo de JSON	A chamada a seguir é usada: `POST /maximo/api/os/object structure?action=importfile Filetype: JSON [ { “assetnum”:”asset number”, “siteid”:”site ID” }, { “assetnum”:”asset number”, “siteid”:”site ID” } ]`
Os dados são importados de forma assíncrona por meio de um arquivo CSV	A chamada a seguir é usada: `POST /maximo/api/os/object structure?action=importfile&name=filename.csv&async=1 CSV file content`

Nota: Ao fazer uma exportação CSV que esteja usando um atributo .notation ou seu alias, a saída foi em menor caso. Esse problema agora foi corrigido no Maximo® Manage 8.5 e a saída agora está em maiúsculas.

A tarefa Cron APIFILEIMPORT recupera os dados importados e processa o conteúdo. A tarefa Cron é executada a cada 30 minutos e é possível configurar com que frequência a tarefa Cron é executada.

Após você importar dados, uma URL de local que contém o status da tarefa Cron APIFILEIMPORT será fornecida. Se ocorrer um erro enquanto a tarefa Cron processar os dados, a resposta para a URL de local será integrada a uma URL que se conecta a um arquivo de erro, que pode ser transferido por download. Quando o erro for resolvido, importe o arquivo novamente. Assegure-se de especificar um novo nome para o parâmetro de consulta name.

Se você estiver usando um arquivo de JSON, para ativar essa resposta de erro, o cabeçalho da solicitação Filetype deverá ser JSON.

A resposta a seguir é um exemplo da resposta para a URL de local quando ocorre um erro. O tipo de arquivo é 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"
}

Exportando Dados

Se você exportar dados usando APIs de REST para uma integração máquina a máquina, deverá criar uma chave de API para o cliente externo.

O formato de arquivo padrão para exportar dados é JSON.

Por exemplo, a chamada de API de REST a seguir exporta dados de ativo, site e local por meio da estrutura de objeto MXAPIASSET como um arquivo CSV:

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

Para aplicativos baseados em função do Maximo Manage , que são baseados na tecnologia Graphite, as APIs REST são usadas para exportar arquivos simples, ou seja, arquivos CSV, de qualquer tabela de interface com o usuário. O processo de exportação é assíncrono e grava o conteúdo da tabela de interface com o usuário página por página em um depósito S3 ou no diretório global Estrutura de integração do Maximo . Em seguida, ele combina as páginas em um único arquivo, que você pode baixar.

Nota: como um administrador, é possível configurar uma montagem de Solicitação de volume persistente (PVC) para todos os pods do Maximo Manage e ligar isso à propriedade mxe.int.globaldir . Ou, deve-se configurar um depósito S3 para a exportação configurando o nome do depósito na propriedade mxe.cosfileexportbucketname . A URL S3, o acesso e a chave secreta são definidos usando as propriedades padrão S3 : mxe.cossecretkey, mxe.cosaccesskey e mxe.cosendpointuri. Se a propriedade mxe.int.globaldir ou a propriedade mxe.cosfileexportbucketname não estiver configurada, a exportação do arquivo não funcionará conforme o esperado

Para obter mais informações sobre as Maximo Mobile APIs REST, consulte Maximo Mobile APIs REST.