Guías de integración › Guía de referencia de la API de BFC › Construcción de URL › Patrón de administración

Patrón de administración

Los tipos incluidos en la API de BFC pueden tener una interfaz de administración opcional para establecer datos de configuración. El patrón de URL es admin/<resource_type>s (por ejemplo, admin/grids).

Este patrón de URL se utiliza cuando la configuración se aplica a todas las instancias del tipo especificado. El patrón de administración también se puede aplicar a una instancia de recurso cuando se especifique una configuración más detallada, por ejemplo, un grid específico. Se logra el ámbito agregando a la URL el ID del recurso de destino:

admin/<resource_type>/<resource_id>

Por ejemplo:

admin/grids/mygrid

Se puede usar GET para que se devuelva un registro cuando el conjunto de datos de la configuración es fijo.

Cuando un destino de administrador tiene muchos valores de configuración, se puede usar una lista dinámica de valores de configuración mediante la cadena de consulta. Esto da flexibilidad al cliente al poder decidir qué fragmentos de datos se debe extraer del servidor. A continuación aparece una URL de ejemplo:

admin/grids?keys=backboneid,licensekey 

Para definir valores de configuración, se utiliza PUT.

Adicionalmente, las interfaces de administración admiten la definición de valores de configuración específicos utilizando PUT en la URL con la clave incluida (por ejemplo, admin/grids/backboneControllerId o /admin/discovery) y una carga útil para el valor o valores actualizados.

Para borrar un valor de configuración, utilice PUT y el valor nulo en el registro correspondiente. Opcionalmente, se puede utilizar DELETE con la clave en la URL (por ejemplo, admin/grids/licensekey o admin/backboneId).

Ejemplo de destino 1

BFC/admin/<resource_type>s,
BFC/admin/<resource_type>/<resource_id>

GET

Recupera la configuración pertinente a resource_type o a resource.

Valor devuelto: registro de configuración.

PUT

Reemplaza la configuración.

Carga útil: registro sucinto que contiene los campos que se deben configurar.

Valor devuelto: Aceptar.

Resultado: los valores de dicho registro se actualizan.

Ejemplo de destino 2

BFC/admin/<resource_type>s/<parameter>,
BFC/admin/<resource_type>/<resource_id>/<parameter> 

GET

Recupera el valor de configuración para el parámetro indicado.

Texto de consulta: N/D.

Valor devuelto: valor de configuración.

PUT

Reemplaza el valor de configuración.

Carga útil: nuevo valor de configuración.

Valor devuelto: Aceptar.

Resultado: se actualiza el valor para el parámetro de configuración especificado.

DELETE

Supresión: se suprime el valor del parámetro de configuración especificado.

Carga útil: N/D.

Valor devuelto: Aceptar.

Resultado: se anula la configuración del valor para el parámetro de configuración especificado.