Cargas por órgão avulso (independente)
Alguns órgãos dentro de um patriarca (por exemplo, empresas públicas) possuem gestão própria de RH e não são atualizados pela carga do patriarca inteiro.
Para esses casos existe a rota base:
/v3/cargas/orgaos
A autorização é concedida diretamente ao órgão raiz, e a carga alcança apenas esse órgão.
Headers comuns:
- 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/cargas/orgaos/{orgaoId}/organograma
Envia a estrutura completa de unidades do órgão raiz controlado de forma avulsa.
POST /v3/cargas/orgaos/{orgaoId}/organograma?dryRun=false
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orgaoId | GUID | Sim | Identificador do órgão raiz autorizado para carga. |
Corpo (JSON)
O corpo segue o modelo CargaOrgaoAvulsoOrganogramaEntrada:
{
"RaizId": "GUID-DO-ORGAO-RAIZ",
"Orgao": {
"ChaveExterna": "ORG-EMPRESA",
"Nome": "Empresa Pública Exemplo",
"Sigla": "EPE",
"Unidades": [ ... ]
}
}
RaizId: deve ser igual aoorgaoIdda rota.Orgao: um objetoOrgaoEntrada(o mesmo modelo da carga de organograma), com suas Unidades[].
Resposta
- 201 Created com um Guid identificando o pedido de carga.
- Erros de validação/autorização retornam 4xx.
POST /v3/cargas/orgaos/{orgaoId}/lotacoes
Envia a carga de lotações (ocupações, lotações, comissões, gestores) para o órgão raiz autorizado.
POST /v3/cargas/orgaos/{orgaoId}/lotacoes?dryRun=false
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orgaoId | GUID | Sim | Identificador do órgão raiz autorizado para carga. |
Corpo (JSON)
O corpo segue o modelo CargaOrgaoAvulsoLotacaoEntrada, que tem os
mesmos campos da CargaLotacaoEntrada, trocando PatriarcaId por
RaizId:
- RaizId (deve ser igual ao
orgaoIdda rota) - ChaveExternaOrgao
- OcupacaoServidor[], LotacoesServidor[], Gestores[]
- OcupacaoComissao[], Comissoes[], LotacoesComissao[]
A carga é interpretada como completa para aquele órgão.
Resposta
- 201 Created com um Guid identificando o pedido de carga.
- Erros de validação/autorização retornam 4xx.
POST /v3/cargas/orgaos/{orgaoId}/pacote-completo
Envia, em uma única chamada, o organograma e as lotações do órgão avulso.
POST /v3/cargas/orgaos/{orgaoId}/pacote-completo?dryRun=false
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orgaoId | GUID | Sim | Identificador do órgão raiz autorizado para carga. |
Corpo (JSON)
O corpo segue o modelo CargaCompletaOrgao:
{
"Organograma": {
"RaizId": "GUID-DO-ORGAO-RAIZ",
"Orgao": { ... }
},
"Lotacoes": {
"PatriarcaId": "GUID-DO-ORGAO-RAIZ",
"ChaveExternaOrgao": "ORG-EMPRESA",
...
}
}
Organograma: um objetoCargaOrgaoAvulsoOrganogramaEntrada.Lotacoes: um único objetoCargaLotacaoEntradacom as lotações do órgão (diferente do pacote completo de patriarca, que recebe um array).
Resposta
- 201 Created com um Guid identificando o pedido de carga.
- Erros de validação/autorização retornam 4xx.
GET /v3/cargas/orgaos/{orgaoId}
Retorna a situação dos últimos pedidos de carga do órgão avulso.
GET /v3/cargas/orgaos/{orgaoId}?limit=10
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orgaoId | GUID | Sim | Identificador do órgão raiz autorizado. |
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 a lista de objetos de status (
CargaViewModel) das cargas mais recentes daquele órgão avulso. Veja o formato em Consulta de status e relatório. - Erros de validação/autorização retornam 4xx.
Para consultar uma carga específica, use:
- GET /v3/cargas/{cargaId}