Ir para o conteúdo principal

Ação | Schema V1 | 2025 - ∞

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
acoes

Item
Campo Chave Informações
codigoUnidadeGestora
codigoAcao
descricaoAcao
tipoAcao ListaTabela de TiposTipo Ação:
0 – Operações Especiais
1 – Projeto
2 – Atividade
descricaoMeta
unidadeMedida
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 Ações",
  "description": "Lista de objetos representando a entidade Ação",
  "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"]
    },
    "acoes": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "Ação",
        "description": "Representação do schema para envio da entidade Ação",
        "type": "object",
        "properties": {
          "codigoUnidadeGestora": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "codigoAcao": {
            "type": "string",
            "minLength": 4,
            "maxLength": 4,
            "pattern": "^[0-9]+$"
          },
          "descricaoAcao": {
            "type": "string",
            "minLength": 10,
            "maxLength": 70
          },
          "tipoAcao": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "descricaoMeta": {
            "type": "string",
            "minLength": 10,
            "maxLength": 150
          },
          "unidadeMedida": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoUnidadeGestora",
          "codigoAcao",
          "descricaoAcao",
          "tipoAcao",
          "descricaoMeta",
          "unidadeMedida",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "acoes"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{  
   "timestamp": "2025-09-11T15:30:00.123456",  
   "acoes": [  
     {  
       "codigoUnidadeGestora": "123456",  
       "codigoAcao": "9876",  
       "descricaoAcao": "Construção de escolas municipais",  
       "tipoAcao": "1",  
       "descricaoMeta": "Construir 5 novas unidades escolares até o final do exercício",  
       "unidadeMedida": "unidade",  
       "action": "CREATE"  
     },
     {  
       "codigoUnidadeGestora": "123456",  
       "codigoAcao": "3331",  
       "descricaoAcao": "Construção de hospitais",  
       "tipoAcao": "1",  
       "descricaoMeta": "Construir 5 hospitais",  
       "unidadeMedida": "Medida",  
       "action": "DELETE"  
   }  
 ]  
}