Importações iniciais

Os endpoints de importação inicial são usados para a primeira carga de um patriarca, quando a estrutura ainda não existe nos sistemas corporativos, a massa de dados sendo importada é grande e não existe sistema para fazer a carga de forma automática, ou seja, o cadastro futuro será manual.

Diferente das cargas regulares, a importação inicial identifica órgãos e unidades pelas siglas (e não por chave externa), usando os modelos CargaInicialOrganogramaEntrada e CargaInicialLotacaoEntrada (veja Modelos de dados – Importação inicial).

Rota base da API v3:

/v3/importacoes-iniciais

Headers comuns a todos os endpoints:

• Authorization: Bearer {access_token}
• Content-Type: application/json (para requisições com corpo)

Parâmetro de query comum aos endpoints de envio de carga (POST):

Nome	Tipo	Obrigatório	Padrão	Descrição
dryRun	boolean	Não	false	Quando true, a carga é executada em modo de simulação: as validações e o cálculo de alterações são realizados, mas nada é persistido. O resultado pode ser consultado pelo relatório da carga.

POST /v3/importacoes-iniciais/patriarcas/{patriarcaId}/organograma

Envia a estrutura inicial de órgãos e unidades de um patriarca.

POST /v3/importacoes-iniciais/patriarcas/{patriarcaId}/organograma?dryRun=false

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
patriarcaId	GUID	Sim	Identificador do patriarca onde a carga será aplicada.

Corpo (JSON)

O corpo segue o modelo CargaInicialOrganogramaEntrada, com:

• PatriarcaId (deve ser igual ao patriarcaId da rota)
• Orgaos[] (cada um com Nome, Sigla e suas Unidades[])

Resposta

• 201 Created com um Guid no corpo que identifica o pedido de carga.
• Erros de validação/autorização retornam 4xx.

O Guid retornado pode ser usado para consultar o status:

• GET /v3/importacoes-iniciais/{cargaId}

POST /v3/importacoes-iniciais/patriarcas/{patriarcaId}/lotacoes

Envia a carga inicial de lotações de um órgão específico dentro de um patriarca.

POST /v3/importacoes-iniciais/patriarcas/{patriarcaId}/lotacoes?dryRun=false

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
patriarcaId	GUID	Sim	Identificador do patriarca da autorização da carga.

Corpo (JSON)

O corpo segue o modelo CargaInicialLotacaoEntrada, contendo:

• PatriarcaId
• Orgao (sigla do órgão)
• Lotacoes[], Comissoes[], Gestores[]

Resposta

• 201 Created com um Guid identificando o pedido de carga.
• Erros de validação/autorização retornam 4xx.

POST /v3/importacoes-iniciais/patriarcas/{patriarcaId}/lotacoes/pacote

Envia as lotações iniciais de vários órgãos de uma vez, dentro de um mesmo patriarca.

POST /v3/importacoes-iniciais/patriarcas/{patriarcaId}/lotacoes/pacote?dryRun=false

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
patriarcaId	GUID	Sim	Identificador do patriarca da autorização da carga.

Corpo (JSON)

O corpo é um array de objetos CargaInicialLotacaoEntrada, um por órgão, sem repetir a sigla de órgão no mesmo pacote.

Resposta

• 201 Created com um Guid identificando o pedido de carga (pacote único).
• Erros de validação/autorização retornam 4xx.

GET /v3/importacoes-iniciais/{cargaId}

Consulta a situação de um pedido de importação inicial.

GET /v3/importacoes-iniciais/{cargaId}

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
cargaId	GUID	Sim	Identificador do pedido de carga.

Resposta

• 200 OK com um objeto de status (CargaViewModel). Veja o formato em Consulta de status e relatório.
• Erros de validação/autorização retornam 4xx.

Esse endpoint é pensado para ser usado em consulta periódica (polling) até a carga ser concluída ou falhar.

GET /v3/importacoes-iniciais/patriarcas/{patriarcaId}

Retorna a situação dos últimos pedidos de importação inicial de um patriarca.

GET /v3/importacoes-iniciais/patriarcas/{patriarcaId}?limit=10

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
patriarcaId	GUID	Sim	Identificador do patriarca cuja fila será consultada.

Parâmetros de query

Nome	Tipo	Obrigatório	Padrão	Descrição
limit	inteiro	Não	10	Número de itens retornados na consulta. Entre 1 e 10.

Resposta

• 200 OK com uma lista de objetos de status (CargaViewModel) das cargas mais recentes daquele patriarca.
• Erros de validação/autorização retornam 4xx.

GET /v3/importacoes-iniciais/{cargaId}/relatorio

Retorna o relatório resumido de uma importação inicial, com os totais de inclusões, alterações e remoções por tipo de entidade.

GET /v3/importacoes-iniciais/{cargaId}/relatorio

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
cargaId	GUID	Sim	Identificador do pedido de carga.

Resposta

• 200 OK com um objeto RelatorioCarga. Veja o formato em Consulta de status e relatório.
• Erros de validação/autorização retornam 4xx.