FormModule
Módulo de Formularios de Shori.
Permite gestionar formularios mediante operaciones de creación, actualización, consulta y búsqueda.
Endpoints soportados
POST /v2/form
PUT /v2/form
GET /v2/form/{formId}
POST /v2/form/search
Metodos
create(@NonNull FormCreateRequest request)
Crear formulario
Consume el endpoint:
POST /v2/form
El formulario será asociado al cliente indicado en la solicitud.
FormModuleResponse response = client.form().create(
FormCreateRequest.builder()
.name("Formulario Cliente")
.description("Formulario de registro")
.clientId("client-uuid")
.versionMajor(1)
.versionMinor(0)
.active(true)
.build()
);
Parametros:
request— datos requeridos para la creación del formulario
Retorna: respuesta con la información del formulario creado
update(@NonNull FormUpdateRequest request)
Actualizar formulario
Consume el endpoint:
PUT /v2/form
Permite modificar nombre, descripción, versión y demás propiedades del formulario.
FormUpdateResponse response = client.form().update(
FormUpdateRequest.builder()
.formId("form-uuid")
.name("Formulario Actualizado")
.clientId("client-uuid")
.active(true)
.build()
);
Parametros:
request— información a actualizar
Retorna: formulario actualizado
findById(@NonNull String formId)
Consultar formulario
Obtiene el detalle de un formulario por identificador.
Consume el endpoint:
GET /v2/form/{formId}
FormModuleResponse response =
client.form().findById("form-uuid");
Parametros:
formId— UUID del formulario
Retorna: detalle completo del formulario
search(@NonNull FormFilter filter)
Buscar formularios
Realiza una búsqueda paginada de formularios.
Consume el endpoint:
POST /v2/form/search
Soporta filtros por identificador, nombre, cliente, tenant, versión, componente, estado y eliminación lógica.
FormFilter.builder()
.name(FilterOperator.LIKE, "Registro")
.active(FilterOperator.EQ, "true")
.pageSize(50)
.build();
Parametros:
filter— criterios de búsqueda
Retorna: resultado paginado de formularios