Esquemas de Configuración
La funcionalidad de Esquemas define la estructura y los atributos de todas las configuraciones gestionadas por la API. Al proporcionar esquemas detallados para las cargas útiles y los campos buscables, se asegura la consistencia e integridad de los datos.
La API proporciona tres puntos finales de esquema:
GET/settings-objects/schemas: Recupera los esquemas de campos buscables y de carga para todos los tipos de configuración.
GET/objetos-de-configuración/{settingType}/ejemplos/cargaútil: Devuelve el esquema de carga útil específico para un tipo de configuración dado.
OBTENER/ajustes-objetos/{settingType}/ejemplos/camposBuscables: Recupera los campos buscables asociados con un tipo de configuración específico.
Cada esquema describe el data type de cada campo y especifica los campos obligatorios requeridos en la carga útil.
GET/ajustes-objetos/esquemas Ejemplo de Respuesta
{
"settings": [
{
"settingType": "testType",
"searchableFieldsSchema": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string"
},
"status": {
"type": "string"
},
"processingEntity": {
"type": "string"
},
"source": {
"type": "string"
},
"id": {
"type": "string"
},
"idList": {
"type": "array",
"items": {
"type": "string"
}
},
"atTime": {
"type": "string",
"format": "date-time"
}
}
},
"payloadSchema": {
"TestSubSetting": {
"required": [
"uniqueId"
],
"type": "object",
"properties": {
"uniqueId": {
"type": "string"
}
}
},
"CommonTestSubSetting": {
"required": [
"uniqueId"
],
"type": "object",
"properties": {
"uniqueId": {
"type": "string"
},
"commonField": {
"type": "string"
}
}
},
"TestSetting": {
"required": [
"testSubSetting",
"testSubSettings",
"uniqueId"
],
"type": "object",
"properties": {
"uniqueId": {
"maxLength": 70,
"minLength": 0,
"type": "string"
},
"anotherField": {
"maxLength": 70,
"minLength": 1,
"pattern": "[0-9A-Z]{11}",
"type": "string"
},
"testSubSetting": {
"$ref": "#/components/schemas/TestSubSetting"
},
"testSubSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TestSubSetting"
}
},
"testEnum": {
"type": "string",
"enum": [
"VALUE_1",
"VALUE_2"
]
},
"commonTestSubSetting": {
"$ref": "#/components/schemas/CommonTestSubSetting"
}
}
}
}
}
]
}