Ir para o conteúdo principal

Programa | Schema V1 | 2026 - ∞

Tipo Envio: Orçamento

Objeto Raiz
Campo Informações
timestamp Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
programas

Item
Campo Chave Informações
codigoUnidadeGestora
codigoPrograma
descricaoPrograma
descricaoObjetivo
tipoObjetivoMilenio Tabela Tipo Objetivo Milênio 
action Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão

Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Lista de Programas",
  "description": "Lista de objetos representando a entidade Programa",
  "type": "object",
  "properties": {
   "timestamp": {
      "type": "string",
      "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)\\.\\d{3,6}$",
      "examples": ["2025-09-11T15:30:00.123456"]
    },
    "programas": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "Programa",
        "description": "Representação do schema para envio da entidade Programa",
        "type": "object",
        "properties": {
          "codigoUnidadeGestora": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "codigoPrograma": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "descricaoPrograma": {
            "type": "string",
            "minLength": 20,10,
            "maxLength": 70
          },
          "descricaoObjetivo": {
            "type": "string",
            "minLength": 15,10,
            "maxLength": 150
          },
          "tipoObjetivoMilenio": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "codigoPrograma",
          "descricaoPrograma",
          "descricaoObjetivo",
          "tipoObjetivoMilenio",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "programas"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "programas": [
    {
      "codigoUnidadeGestora": "123456",
      "codigoPrograma": "0001",
      "descricaoPrograma": "Programa de Desenvolvimento Urbano Sustentável",
      "descricaoObjetivo": "Promover melhorias na infraestrutura e na qualidade de vida urbana.",
      "tipoObjetivoMilenio": "01",
      "action": "CREATE"
    },
    {
      "codigoUnidadeGestora": "654321",
      "codigoPrograma": "0002",
      "descricaoPrograma": "Programa de Educação Inclusiva e Inovadora",
      "descricaoObjetivo": "Garantir acesso à educação de qualidade e promover a inclusão social.",
      "tipoObjetivoMilenio": "02",
      "action": "UPDATE"
    }
  ]
}