Detalhe do pedido:
- URL base: {host}/ASMSAPI/
- URI: api/v9/article/list
- Tipo: POST
-
Títulos obrigatórios:
- Tipo de conteúdo: application/json
- Autorização X: Portador {token}
Descrição do URL
- {host}: Ele representa o domínio do ambiente no qual a API está localizada.
- ASMSAPI/: Prefixo de API fixo.
- URI: Ponto de extremidade específico para a solicitação.
⚐ URL DE EXEMPLO:
https://{host}/ASMSAPI/api/v9/article/list
Parâmetros:
Nome | Cara | Obrigatório | Descrição |
---|---|---|---|
Tipo de console | Corda | Sim | Tipo de console - Especialista = 1, - Cliente = 2, - Administrador - 3. |
éPúblico | Booleano | Não | Indique se a pesquisa é para itens públicos ou privados. |
Modelos | Objeto | Não | Objeto com os tipos de itens a serem listados. |
Id | Todo | Não | Identificador de tipo de item. |
Projetos | Objeto | Sim | Objeto com os projetos a serem listados. |
Id | Todo | Sim | ID do projeto. |
categorias (pasta) | Objeto | Não | Objeto com as pastas a serem listadas (necessário apenas para o especialista e o console do cliente quando o parâmetro do modelo tem valor). |
Id | Todo | Não | Identificador das pastas. |
repositório | Corda | Sim | Indica se ele pesquisa aberto ou todos. - Aberto = 1 - Fechado = 2 - Todos = 3 |
procurar | Corda | Sim | Cadeia de caracteres de pesquisa. |
índice de páginas | Todo | Sim | Identificador da página listada. |
Pagesize | Todo | Sim | Número de registros na lista. |
orderField | Corda | Sim | Campo pelo qual fazer o pedido. |
tipo de pedido | Corda | Sim | Ordenação: - Desc - Asc |
•Asc. |
Exemplos de uri:
api/v9/artigo/lista
Corpo da petição:
{
"consoleType": 1,
"categories": [
{
"id": 1
}
],
"models": [
{
"id": 12
}
],
"projects": [
{
"id": 4
}
],
"repository": 3,
"pageIndex": 0,
"pageSize": 15,
"orderField": "openedDate",
"orderType": "Desc",
"search": "",
"isPublic": 0
}
Responder:
O serviço retornará um Json com a seguinte 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
}
Mensagens de erro:
Código | Status HTTP | Mensagem de erro |
---|---|---|
400 | Solicitação BadRequest | \r\nNome do parâmetro: request |
400 | Solicitação BadRequest | \r\nNome do parâmetro: consoleType |
400 | Solicitação BadRequest | \r\nNome do parâmetro: repository |
400 | Solicitação BadRequest | CategoryIdIsRequired |
500 | Erro de servidor interno | FalhaGetList |