Configuración CRUD
La Configuración API soporta todas las operaciones de Crear, Leer, Actualizar y Eliminar (CRUD) relacionadas con un tipo de configuración.
Los cambios en la configuración se escriben en la base de datos de Configuración.
Las operaciones CRUD son compatibles a través de cuatro puntos finales dedicados:
| POST/configuración-objetos/{settingType} |
Crea un entorno por primera vez. Un entorno debe pertenecer a una Entidad de Procesamiento, en caso de que se cree un entorno sin el processingEntity definido entonces la Entidad de Procesamiento propietaria se establecerá por defecto en DESCONOCIDO. En caso de que la configuración tenga como fuente IMPORT y processingEntity falta en la solicitud (o tiene el valor DESCONOCIDO), entonces se realizará la creación o actualización, se creará si la configuración no existe y se actualizará si la configuración existe. |
| PONGA /settings-objects/{settingType}/{settingId} |
Actualiza una configuración que está actualmente "en uso"/activa o, si no existe una configuración programada, entonces se puede crear una configuración programada a través de este punto final. Las solicitudes deben tener el processingEntity valor definido. |
| ELIMINAR /settings-objects/{settingType}/{settingId} |
Elimina una configuración activa. La opción de processingEntity El parámetro, si se proporciona en la solicitud, asegura que una Entidad de Procesamiento solo pueda eliminar sus propias configuraciones. |
| OBTENER /objetos-de-configuración/{settingType}/{settingId} |
Recupera configuraciones "en uso"/activas. El opcional processingEntity El parámetro, si se proporciona en la solicitud, asegura que una Entidad de Procesamiento solo pueda recuperar sus propias configuraciones. |
Características
Estos puntos finales admiten dos funciones clave:
Aprobaciones
Se pueden crear, actualizar o eliminar configuraciones con o sin aprobaciones. Esta funcionalidad ya está disponible en DPS v1. El requiresApproval el campo controla este comportamiento, aceptando valores verdaderos o falsos.
Si se establece en verdadero, la configuración permanece inactiva hasta que sea aprobada.
Si se omite o se establece en falso (por defecto), la configuración se activa de inmediato.
Validación
Durante la ejecución de operaciones CRUD, el sistema realiza una verificación para determinar si hay una aprobación pendiente. Si existe una aprobación pendiente, la operación no puede ser ejecutada.
Excepción: Ingesta de Datos de la Industria
Esta regla no se aplica al ingerir datos de la industria. Para los datos de la industria, se omite la verificación de aprobación pendiente.
Los datos de la industria se identifican en función de los siguientes criterios:
-
El processingEntity no está configurado o es DESCONOCIDO.
-
La fuente es IMPORT.
Scheduling
Se pueden crear o actualizar configuraciones con un futuro activeFromDate. Esta función es nueva y no estaba disponible en DPS v1. El activeFromDate el campo determina si una configuración es actual o programada:
Un ajuste actual está en uso activo. Para crear o actualizar un ajuste actual, establezca activeFromDate a la fecha y hora actuales o déjelo vacío (se establece de forma predeterminada en la fecha y hora actuales).
Una configuración programada entra en vigor en una fecha y hora futuras. Para programar una configuración, establezca activeFromDate a la fecha y hora futura deseada. La configuración se activará automáticamente cuando se alcance la fecha y hora.
Estados
Después de enviar una solicitud para crear, actualizar o eliminar una configuración, se puede devolver uno de los cuatro posibles estados:
ACTIVO – Se asigna cuando se crea o actualiza una configuración sin requerir aprobación. Este estado se aplica tanto a configuraciones actuales como programadas. Además, una configuración también se vuelve activa tras la aprobación de una operación de creación o actualización.
INACTIVO – Se aplica cuando se elimina una configuración actual sin requerir aprobación. Si se necesita aprobación, la configuración permanece inactiva hasta que se apruebe la solicitud de eliminación.
INACTIVE_APPROVAL_PENDING – Indica que una configuración actual o programada recién creada está a la espera de aprobación antes de volverse activa.
ACTIVE_APPROVAL_PENDING – Asignado cuando una solicitud de actualización o eliminación de una configuración actual o programada está pendiente de aprobación.
Manejo de Entidades de Procesamiento
Una configuración solo puede estar asociada con una única Entidad de Procesamiento, la processingEntity El valor en una configuración identifica la Entidad de Procesamiento a la que se aplica la configuración.
Crear, Leer, Actualizar y Eliminar operaciones que tienen el processingEntity definido permitir para acceso restringido basado en el processingEntity valor en la solicitud y la Entidad de Procesamiento propietaria de la configuración. Llamadas que no incluyen el processingEntity no permita el acceso basado en restricciones.
| Las solicitudes de actualización DEBEN tener siempre el processingEntity definido |