Detalle de la petición::
- URI: api/v9/article/list
- Tipo: POST
- Encabezados requeridos:
- Content-Type: application/json
- X-Authorization: Bearer {token}
Parámetros:
Nombre | Tipo | Obligatorio | Descripción |
---|---|---|---|
ConsoleType | String | Si | Tipo de consola - Specialist = 1, - Client = 2, - Administrator - 3. |
isPublic | Booleano | No | Indica si la búsqueda es de artículos públicos o privados. |
models (tipos) | Object | No | Objeto con los tipos de artículos a listar. |
id | Entero | No | Identificador del tipo de artículo. |
projects | Object | Si | Objeto con los proyectos a listar. |
id | Entero | Si | Identificador del proyecto. |
categories (Folder) | Object | No | Objeto con los folders a listar (Solo es obligatorio para consola de especialista y cliente cuando el parámetro modelo tiene valor). |
id | Entero | No | Identificador de los folders. |
repository | String | Si | Indica si busca en abiertos o todos. - Abiertos = 1 - Cerrados = 2 - Todos =3 |
search | String | Si | String de búsqueda. |
pageIndex | Entero | Si | Identificador de la página que lista. |
pageSize | Entero | Si | Número de registros que trae el listado. |
orderField | String | Si | Campo por el cual ordenar. |
orderType | String | Si | Ordenamiento: - Desc - Asc |
• Asc. |
Ejemplos de uri:
api/v9/article/list
Cuerpo de la petición:
{
"consoleType": 1,
"categories": [
{
"id": 1
}
],
"models": [
{
"id": 12
}
],
"projects": [
{
"id": 4
}
],
"repository": 3,
"pageIndex": 0,
"pageSize": 15,
"orderField": "openedDate",
"orderType": "Desc",
"search": "",
"isPublic": 0
}
Respuesta:
El servicio retornará un Json con la siguiente estrutura:
{
"content": [
{
"autorId": null,
"classId": null,
"content": "",
"createdDate": 1696443888080,
"description": "Nisi eos molestiae est neque assumenda neque nisi.",
"groupId": null,
"hitTotal": null,
"id": 46,
"identifier": "Quis vero amet.",
"interfaceId": null,
"isFavorite": false,
"isPublic": false,
"keyword": "",
"modifiedDate": 1696443888080,
"modifierId": null,
"openedDate": 1696443888080,
"projectId": null,
"public": 0,
"ratingTotal": 0,
"reasonId": null,
"reasonName": null,
"responsibleId": 1,
"stateId": 174,
"stateName": "Diseño",
"stringStateColor": "139.78.168",
"title": "Est exercitationem fuga nobis tempore aut.",
"typeId": 12,
"typeName": "Errores Conocidos",
"url": ""
},
{
"autorId": null,
"classId": null,
"content": "",
"createdDate": 1696439222233,
"description": "Inventore quasi delectus nulla sed iure nesciunt eaque distinctio.",
"groupId": null,
"hitTotal": null,
"id": 44,
"identifier": "Et quo ipsum recusandae.",
"interfaceId": null,
"isFavorite": false,
"isPublic": false,
"keyword": "",
"modifiedDate": 1696439222233,
"modifierId": null,
"openedDate": 1696439222233,
"projectId": null,
"public": 0,
"ratingTotal": 0,
"reasonId": null,
"reasonName": null,
"responsibleId": 1,
"stateId": 174,
"stateName": "Diseño",
"stringStateColor": "139.78.168",
"title": "Sed iusto nemo quidem sint dolor distinctio cum vitae officiis.",
"typeId": 12,
"typeName": "Errores Conocidos",
"url": ""
},
{
"autorId": null,
"classId": null,
"content": "",
"createdDate": 1695128891753,
"description": "Consectetur eveniet dolores voluptatem.",
"groupId": null,
"hitTotal": null,
"id": 43,
"identifier": "Quod sunt vel quibusdam suscipit minima nulla corporis doloribus ea.",
"interfaceId": null,
"isFavorite": false,
"isPublic": false,
"keyword": "",
"modifiedDate": 1695128891753,
"modifierId": null,
"openedDate": 1695128891753,
"projectId": null,
"public": 0,
"ratingTotal": 0,
"reasonId": null,
"reasonName": null,
"responsibleId": 1,
"stateId": 174,
"stateName": "Diseño",
"stringStateColor": "139.78.168",
"title": "Eaque quos sequi.",
"typeId": 12,
"typeName": "Errores Conocidos",
"url": ""
},
{
"autorId": null,
"classId": null,
"content": "",
"createdDate": 1695128558867,
"description": "Voluptate odio provident placeat et omnis saepe.",
"groupId": null,
"hitTotal": null,
"id": 42,
"identifier": "Qui totam neque esse enim incidunt optio.",
"interfaceId": null,
"isFavorite": false,
"isPublic": false,
"keyword": "",
"modifiedDate": 1695128558867,
"modifierId": null,
"openedDate": 1695128558867,
"projectId": null,
"public": 0,
"ratingTotal": 0,
"reasonId": null,
"reasonName": null,
"responsibleId": 1,
"stateId": 174,
"stateName": "Diseño",
"stringStateColor": "139.78.168",
"title": "Sit est qui nam minima.",
"typeId": 12,
"typeName": "Errores Conocidos",
"url": ""
},
{
"autorId": null,
"classId": null,
"content": "",
"createdDate": 1693847348663,
"description": "Officia ducimus provident sint a.",
"groupId": null,
"hitTotal": null,
"id": 40,
"identifier": "Dignissimos accusamus magni iste.",
"interfaceId": null,
"isFavorite": false,
"isPublic": false,
"keyword": "",
"modifiedDate": 1693847348663,
"modifierId": null,
"openedDate": 1693847348663,
"projectId": null,
"public": 0,
"ratingTotal": 0,
"reasonId": null,
"reasonName": null,
"responsibleId": 1,
"stateId": 174,
"stateName": "Diseño",
"stringStateColor": "139.78.168",
"title": "Voluptates aliquid quisquam sed voluptate ipsam omnis eveniet quia.",
"typeId": 12,
"typeName": "Errores Conocidos",
"url": ""
},
{
"autorId": null,
"classId": null,
"content": "",
"createdDate": 1693845486933,
"description": "Nulla illum ipsa vel iure tempora vitae cupiditate vel recusandae.",
"groupId": null,
"hitTotal": null,
"id": 37,
"identifier": "Harum sit rem.",
"interfaceId": null,
"isFavorite": false,
"isPublic": false,
"keyword": "",
"modifiedDate": 1693845486933,
"modifierId": null,
"openedDate": 1693845486933,
"projectId": null,
"public": 0,
"ratingTotal": 0,
"reasonId": null,
"reasonName": null,
"responsibleId": 1,
"stateId": 174,
"stateName": "Diseño",
"stringStateColor": "139.78.168",
"title": "Mollitia aliquam nostrum dolor hic qui quo aspernatur.",
"typeId": 12,
"typeName": "Errores Conocidos",
"url": ""
}
],
"totalItems": 6,
"totalPage": 6
}
Mensajes de error:
Código | Estado HTTP | Mensaje de error |
---|---|---|
400 | BadRequest | \r\nNombre del parámetro: request |
400 | BadRequest | \r\nNombre del parámetro: consoleType |
400 | BadRequest | \r\nNombre del parámetro: repository |
400 | BadRequest | CategoryIdIsRequired |
500 | InternalServerError | FailureGetList |