Saltar al contenido principal

list

La función del api /v1/dossier/list puede contener los siguientes parametros:

/v1/dossier/list / sort / framecode / skip / limit ? format= flat

  • sort. Indica la variable o propiedad por la que ordenaran los datos de la lista. La variable puede estar seguida por : y luego asc o des para indicar si es ascendente o descendente. Puede omitirse. Preferiblemente la variable no deberia empezar por dossier.
  • framecode. Es el código del frame que se quiere listar. Los frames estan contenidos dentro de los Views.
  • skip. Indica cuantos registros debe saltarse antes de dar el primero. Puede omitirse, y en ese caso el valor por defecto sera 0.
  • limit. Indica cuantos datos devuelve en esa peticion. Puede omitirse, pero en ese caso tomara 100 como valor limite.

La estructura devuelta es del siguiente tipo:

[
{
"dossier": {
"header": {
"name": "Este es el primer dossier x3",
"code": "00001",
"description": "Dossier de prueba para la demo de la API de Mood",
"owner": "pablo@moodrob.com",
"status": ""
}
}
},
{
"dossier": {
"header": {
"name": "Este es el tercer dossier",
"code": "00003",
"description": "Dossier de prueba para la demo de la API de Mood",
"owner": "pablo@moodrob.com",
"status": ""
}
}
}
]

En el caso de que se necesite una estructura 'plana' se puede utilizar el parametro flat de la siguiente forma:

/v1/dossier/list/?format=flat

[
{
"dossier.header.name": "Este es el primer dossier x3",
"dossier.header.code": "00001",
"dossier.header.description": "Dossier de prueba para la demo de la API de Mood",
"dossier.header.owner": "pablo@moodrob.com",
"dossier.header.status": ""
},
{
"dossier.header.name": "Este es el tercer dossier",
"dossier.header.code": "00003",
"dossier.header.description": "Dossier de prueba para la demo de la API de Mood",
"dossier.header.owner": "pablo@moodrob.com",
"dossier.header.status": ""
}
]