Relacionamento Empenho Obra | 2025 -
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Código Unidade Gestora Obra - Número Obra - Ano Empenho ]
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
elementos
–
Item
Campo
Chave
Informações
codigoUnidadeOrcamentaria
✅
–
numeroEmpenho
✅
–
codigoUnidadeGestoraObra
✅
–
numeroObra
✅
–
anoEmpenho
✅
–
action
–
Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão
Schema
{
"$schema": "https://jso
"title": "Lista de Relacionamentos Empenho Obra",
"description": "Lista de objetos representando a entidade Relacionamento Empenho Obra",
"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"]
},
"elementos": {
"type": "array",
"uniqueItems": true,
"items": {
"title": "Relacionamento Empenho Obra",
"description": "Representação do schema para envio da entidade Relacionamento Empenho Obra",
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho":
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroObra": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"anoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"codigoUnidadeGestoraObra",
"numeroObra",
"anoEmpenho",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000001",
"codigoUnidadeGestoraObra": "123456",
"numeroObra": "OBRA0001",
"anoEmpenho": "2025",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000002",
"codigoUnidadeGestoraObra": "654321",
"numeroObra": "OBRA0002",
"anoEmpenho": "2024",
"action": "UPDATE"
}
]
}
Regras
ID
Regra
RELACIONAMENTO_EMPENHO_OBRA_DUPLICIDADE_NAO_PERMITIDA
Não é permitido cadastrar registros duplicados pela chave de unicidade
RELACIONAMENTO_EMPENHO_OBRA_EMPENHO_CADASTRADO
O empenho deve ter sido cadastrado para a unidade gestora
RELACIONAMENTO_EMPENHO_OBRA_CADASTRADA_GEO_OBRAS
Quando informada, a obra deve ter sido cadastrada no Geo Obras