Modelo de dados – Organograma

A carga de organograma envia a estrutura completa de órgãos e unidades de um patriarca.

Ela usa o objeto CargaOrganogramaEntrada, que contém:

• o identificador do patriarca; e
• a lista de órgãos com suas unidades internas.

Objeto CargaOrganogramaEntrada

{
  "PatriarcaId": "GUID-DO-PATRIARCA",
  "Orgaos": [ { ... } ]
}

Campo	Tipo	Obrigatório	Descrição
PatriarcaId	string (GUID)	Sim	Identificador do patriarca onde a carga será aplicada. Deve corresponder ao patriarca da autorização.
Orgaos	array	Sim	Lista de órgãos que pertencem ao patriarca. Cada item é um OrgaoEntrada.

Objeto OrgaoEntrada

Representa um órgão (secretaria, autarquia, prefeitura, empresa pública etc.) e suas unidades internas.

{
  "ChaveExterna": "ORG-SESA",
  "Nome": "Secretaria de Estado da Saúde",
  "Sigla": "SESA",
  "Unidades": [ { ... } ]
}

Campo	Tipo	Obrigatório	Descrição
ChaveExterna	string	Sim	Identificador único do órgão no seu sistema. Máximo de 200 caracteres. Normalizado em maiúsculas.
Nome	string	Sim	Nome completo do órgão. Máximo de 100 caracteres. Espaços normalizados, texto armazenado em maiúsculas.
Sigla	string	Sim	Sigla do órgão. Máximo de 20 caracteres. Espaços normalizados, texto armazenado em maiúsculas.
Unidades	array	Sim	Lista de unidades internas do órgão. Cada item é uma UnidadeEntrada.

Objeto UnidadeEntrada

Representa uma unidade organizacional interna do órgão (departamentos, gerências, divisões etc.).

{
  "ChaveExterna": "ORG-SESA-UNID-GERH",
  "Nome": "Gerência de Recursos Humanos",
  "Sigla": "GERH",
  "ChaveUnidadePai": null
}

Campo	Tipo	Obrigatório	Descrição
ChaveExterna	string	Sim	Identificador único da unidade no seu sistema. Máx. 200 caracteres. Normalizado em maiúsculas.
Nome	string	Sim	Nome da unidade. Máx. 100 caracteres. Armazenado em maiúsculas.
Sigla	string	Sim	Sigla da unidade. Máx. 25 caracteres. Armazenado em maiúsculas.
ChaveUnidadePai	string ou null	Não	Chave externa da unidade mãe. Deve referenciar outra unidade do mesmo órgão. Use null para unidades raiz.

A árvore de unidades é montada com base em ChaveUnidadePai. Certifique-se de que todas as chaves usadas como pai existam na mesma lista de unidades do órgão.

Exemplo completo de carga de organograma

{
  "PatriarcaId": "8f1d9f5b-0a8e-4f5b-a12b-2a3b4c5d6e7f",
  "Orgaos": [
    {
      "ChaveExterna": "ORG-SESA",
      "Nome": "Secretaria de Estado da Saúde",
      "Sigla": "SESA",
      "Unidades": [
        {
          "ChaveExterna": "ORG-SESA-UNID-SEC",
          "Nome": "Secretaria Executiva",
          "Sigla": "SECEX",
          "ChaveUnidadePai": null
        },
        {
          "ChaveExterna": "ORG-SESA-UNID-GERH",
          "Nome": "Gerência de Recursos Humanos",
          "Sigla": "GERH",
          "ChaveUnidadePai": "ORG-SESA-UNID-SEC"
        }
      ]
    }
  ]
}