Configuraciones CRUD
The Settings API supports all Create, Read, Update, and Delete (CRUD) operations relating to a setting type.
Los cambios de configuraciones se escriben en la base de datos de Settings.
Las operaciones CRUD están soportadas a través de cuatro endpoints dedicados:
| POST/settings-objects/{settingType} |
Crea una configuración por primera vez. En caso de que una configuración se elimine y más adelante se requiera una nueva, debe crearse mediante el endpoint POST. |
| PUT /settings-objects/{settingType}/{settingId} |
Actualiza una configuración que está actualmente "en uso" o, si aún no existe una configuración programada, puede crearse una configuración programada mediante este endpoint. |
| DELETE /settings-objects/{settingType}/{settingId} |
Elimina la configuración actual y la configuración programada (si existe). |
| GET /settings-objects/{settingType}/{settingId} |
Recupera información relacionada con la configuración actual. |
Funcionalidades
Estos endpoints soportan dos características clave:
Aprobaciones
Las configuraciones pueden crearse, actualizarse o eliminarse con o sin aprobaciones. Esta funcionalidad ya está disponible en DPS v1. El campo requiresApproval controla este comportamiento, aceptando valores true o false.
Si se establece en true, la configuración permanece inactiva hasta que sea aprobada.
Si se omite o se establece en false (predeterminado), la configuración se vuelve activa inmediatamente.
Programación
Las configuraciones pueden crearse o actualizarse con un activeFromDate futuro. Esta característica es nueva y no estaba disponible en DPS v1. El campo activeFromDate determina si una configuración es actual o programada:
Una configuración actual está en uso activo. Para crear o actualizar una configuración actual, establezca activeFromDate a la fecha y hora actuales o déjelo vacío (por defecto toma 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 deseadas en el futuro. La configuración se activará automáticamente cuando se alcance ese momento.
Estados
Tras enviar una solicitud para crear, actualizar o eliminar una configuración, pueden devolverse cuatro estados posibles:
ACTIVE – Asignado cuando una configuración se crea o actualiza sin requerir aprobación. Este estado aplica tanto a configuraciones actuales como programadas. Además, una configuración también pasa a activa después de la aprobación de una operación de creación o actualización.
INACTIVE – Aplica cuando una configuración actual se elimina 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 para una configuración actual o programada está pendiente de aprobación.