Parámetros de la consulta

Algunas solicitudes tomarán parámetros de consulta adicionales que modificarán o mejorarán los datos devueltos. Consulte la documentación para cada recurso para obtener detalles. No todos los recursos admitirán todos los parámetros de cada consulta. Esta sección solo documenta los parámetros de consulta que se usarán cuando un recurso implemente el parámetro de consulta especificado.

Tabla 1-2  Parámetros de consulta especificados:

Parámetro Descripción props=true Detallar los metadatos de la propiedad de un recurso (el valor predeterminado es "false"). limit=n Limitar el número de elementos de lista devueltos. start=n Número de índice (o tiempo) utilizado para iniciar los datos de elementos devueltos.

Parámetro de consulta: props

El parámetro de consulta props se puede utilizar en varios comandos GET que devuelven una instancia de recurso única. Devolverá un elemento de datos "props" que contiene una lista de metadatos de propiedad.

Tabla 1-3  Valores de metadatos de propiedad

Propiedad Descripción name Nombre de propiedad label Descripción de la propiedad immutable Indicador que muestra que la propiedad no se puede modificar. type Tipo de propiedad: String, Integer, Boolean... choices Para propiedades enumeradas, una matriz de valores disponibles

Parámetro de consulta: limit

La consulta limit se puede usar en varios comandos GET que devuelven un gran número de elementos a fin de limitar el número máximo de elementos devueltos.

Parámetro de consulta: start

El parámetro de consulta start se admite en los mismos comandos que admiten el parámetro limit. Proporciona el índice start que se usa para iniciar los datos devueltos. Para los recursos que admiten valores de tiempo, el índice puede ser un valor de tiempo, como "20130531T01:13:58".