Base de Conhecimento

A API de importLayout é responsável por realizar consultas sobre o modelo de importação de cada cliente. Pode realizar consultar através de parâmetros como o ID do modelo de importação, descrição e a entidade do modelo de importação.

Descrição de um Modelo de Importação

Descrição de um Campo do Modelo de Importação

Busca por lista de modelo de importação

GET /CenterWeb/api/{$apiKey}/importLayout.xml

Este recurso permite fazer a busca de modelos de importação de um determinado ambiente. É permitido que você adicione alguns parâmetros na requisição. Os parâmetros são os seguintes:

GET /CenterWeb/api/{$apiKey}/importLayout.xml?description=description

Busca por modelo de importação por descrição.

Realizar pesquisas de modelo de importação utilizando parâmetros pela API uMov.me é simples assim. Veja um exemplo, do resultado de uma requisição que foi feita em XML:

<result>

<resourceName>importLayout</resourceName>

<size>1</size>

<entries>

<entry id="120" link="/importLayout/120.xml"/>

</entries>

</result>

Busca por um modelo de importação específico utilizando ID

GET /CenterWeb/api/{$apiKey}/importLayout/{$id}.xml

Esta operação serve para puxar informações de um modelo de importação do sistema de forma completa. Todos os dados do modelo de importação são retornados nessa requisição. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

<importLayout>

<id>120</id>

<description>Modelo de importação</description>

<active>true</active>

<filePrefix>PSA</filePrefix>

<fields>

<field>

<id>1234</id>

<active>true</active>

<name>command</name>

<mandatory>true</mandatory>

</field>

<field>

<id>4321</id>

<active>true</active>

<name>description</name>

<mandatory>true</mandatory>

</field>

</fields>

...

</importLayout>

Busca de um modelo de importação por entidade

GET /CenterWeb/api/{$apiKey}/importLayout/entity/{$entity}.xml

Está operação serve para listar os modelos de importação de uma determinada entidade. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):

Requisição: GET /CenterWeb/api/{$apiKey}/importLayout/entity/item.xml

<result>

<resourceName>importLayout</resourceName>

<size>1</size>

<entries>

<entry id="49" link="/importLayout/49.xml"/>

</entries>

</result>

Importação e Exportação de Arquivos (ImportLayout (Modelo de Importação))