Modelo de dados – Órgão avulso e pacotes completos

Esta página descreve os envelopes usados nas cargas de órgão avulso e nos endpoints de pacote completo. Eles reutilizam os modelos descritos em Organograma e Lotações.

Objeto CargaOrgaoAvulsoOrganogramaEntrada

Usado em POST /v3/cargas/orgaos/{orgaoId}/organograma e em POST /v3/cargas/patriarcas/{patriarcaId}/orgaos/{orgaoId}/organograma.

{
  "RaizId": "GUID-DO-ORGAO-RAIZ",
  "Orgao": {
    "ChaveExterna": "ORG-EMPRESA",
    "Nome": "Empresa Pública Exemplo",
    "Sigla": "EPE",
    "Unidades": [ { ... } ]
  }
}

Campo	Tipo	Obrigatório	Descrição
RaizId	string (GUID)	Sim	Identificador da raiz autorizada. Deve corresponder ao GUID usado na rota.
Orgao	objeto	Sim	Um único OrgaoEntrada com suas unidades (o mesmo modelo do organograma).

Objeto CargaOrgaoAvulsoLotacaoEntrada

Usado em POST /v3/cargas/orgaos/{orgaoId}/lotacoes. Tem os mesmos campos da CargaLotacaoEntrada, trocando PatriarcaId por RaizId.

{
  "RaizId": "GUID-DO-ORGAO-RAIZ",
  "ChaveExternaOrgao": "ORG-EMPRESA",
  "OcupacaoServidor": [ { ... } ],
  "LotacoesServidor": [ { ... } ],
  "Gestores": [ { ... } ],
  "OcupacaoComissao": [ { ... } ],
  "Comissoes": [ { ... } ],
  "LotacoesComissao": [ { ... } ]
}

Campo	Tipo	Obrigatório	Descrição
RaizId	string (GUID)	Sim	Identificador da raiz autorizada. Deve corresponder ao GUID usado na rota.
demais campos	—	Sim	Os mesmos de CargaLotacaoEntrada (veja Lotações).

Objeto CargaCompletaPatriarca

Usado em POST /v3/cargas/patriarcas/{patriarcaId}/pacote-completo. Reúne organograma e lotações do patriarca em uma única carga.

{
  "Organograma": {
    "PatriarcaId": "GUID-DO-PATRIARCA",
    "Orgaos": [ { ... } ]
  },
  "Lotacoes": [
    { "PatriarcaId": "GUID-DO-PATRIARCA", "ChaveExternaOrgao": "ORG-SESA", ... },
    { "PatriarcaId": "GUID-DO-PATRIARCA", "ChaveExternaOrgao": "ORG-SEJUS", ... }
  ]
}

Campo	Tipo	Obrigatório	Descrição
Organograma	objeto	Sim	Um CargaOrganogramaEntrada com toda a estrutura do patriarca.
Lotacoes	array	Sim	Array de CargaLotacaoEntrada, um item por órgão, sem repetir ChaveExternaOrgao.

Objeto CargaCompletaOrgao

Usado em POST /v3/cargas/orgaos/{orgaoId}/pacote-completo. Reúne organograma e lotações do órgão avulso em uma única carga.

{
  "Organograma": {
    "RaizId": "GUID-DO-ORGAO-RAIZ",
    "Orgao": { ... }
  },
  "Lotacoes": {
    "PatriarcaId": "GUID-DO-ORGAO-RAIZ",
    "ChaveExternaOrgao": "ORG-EMPRESA",
    ...
  }
}

Campo	Tipo	Obrigatório	Descrição
Organograma	objeto	Sim	Um CargaOrgaoAvulsoOrganogramaEntrada.
Lotacoes	objeto	Sim	Um único CargaLotacaoEntrada com as lotações do órgão (diferente do pacote de patriarca, que recebe um array).