Detalhes da petição
- URL base: {host}/ASMSAPI/
- Uri: /api/v9/item/search
- 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/item/search
Parâmetros
Nome | Tipo de dado | Obrigatório | Descrição |
---|---|---|---|
Projetos | Lista | Sim | Lista de projetos. |
Projeto | Número | Sim | ID do projeto. |
Critérios | Objeto | Sim | Objeto com parâmetro de pesquisa. Nota: É obrigatório que o objeto seja incluído no corpo da solicitação. No entanto, não há parâmetros de pesquisa necessários; Estes podem estar vazios. |
campoValor | Texto | Não | Campo pelo qual você deseja pesquisar |
nome_do_campo | Texto | Não | Nome do campo. |
nome do operador | Texto | Não | Nome da operadora. |
operatorValue | Texto | Não | Valor do operador. |
valor | Texto | Não | Valor de pesquisa. |
nome_valor | Texto | Não | Valor da pesquisa |
tipo | Texto | Não | Valor do tipo de dados - Nenhum = 0, Texto curto = 1, - Data e hora = 2, - Lista = 3, - Texto longo = 4, - Caixa de seleção = 5, - Numérico = 6, - Recursivo = 7, - Lista2 = 8, - Decimal = 9, - Arquivo = 10, - Lista de Catálogos = 11, - Árvore de Catálogo = 12 |
filterText | Texto | Não | Texto pelo qual você deseja pesquisar um caso dentro de um tipo de caso, quando este filtro é usado apenas isso é necessário. |
Tipos | Objeto | Não | Lista de tipos de casos. |
tipo de item | Texto | Não | Tipo de caso. |
orderField | Texto | Sim | Parâmetro pelo qual a classificação é necessária. Nota: Os parâmetros pelos quais a ordenação pode ser executada são aqueles incluídos na resposta à solicitação. |
tipo de pedido | Texto | Sim | Tipo de pedido - Asc - Desc |
Pagesize | Número | Sim | Quantidade de dados a serem retornados para paginação. |
índice de páginas | Número | Sim | Número da página. |
Identificação de visualização | Número | Não | Identificador de visualização. |
repositório | Texto | Não | Identificador do repositório, se não for enviado, o valor padrão de aberto será usado.- Aberto = 1 - Fechado = 2 - Todos = 3 |
Corpo da petição
{
"criteria": [],
"level": 0,
"orderField": "openedDate", "orderType": "desc",
"pageIndex": 4,
"pageSize": 50,
"projects": [
{
"project": 25
},
{
"project": 19
}
],
"repository": 1,
"types": [
{
"itemType": 2 },
{
"itemType": 1 },
{
"itemType": 4 },
{
"itemType": 3 },
{
"itemType": 13 }
],
"viewId": -6
}
Responder
{
"content": [
{
"authorId": 4832,
"authorName": "Especialista 1",
"backgroundColorRgb": "0.174.239",
"buildingId": null,
"buildingName": null,
"categoryHierarchy": "Corrección de Reporte", "categoryId": 520,
"categoryName": "Corrección de Reporte",
"ciAssetTag": null,
"ciId": null,
"ciName": null,
"ciSerial": null,
"cityId": null,
"cityName": null,
"closedDate": null,
"closenessToExpiration": 0,
"companyId": 421,
"companyName": "ACH COLOMBIA",
"cost": null,
"countryId": null,
"countryName": null,
"currentprogress": 0,
"currenttime": 0,
"customerId": null,
"customerName": null,
"departmentCode": null,
"departmentCodeName": null,
"descriptionNoHtml": "CambioCuota2FONDO DE EMPLEADOS DE ARANDA SOFTWARE - FAS OFT\nN.I.T. 901067439-6
FORMATO DE ACTUALIZACIÓN DE CUOTA DE AHORRO FECHA MES DIA AÑO
INFORMACION PERSONAL Nombres Apellidos Documento de indentidad Teléfono Celular Correo Electrónico
TIPO DE AHORRO (Seleccione con una X) Ahorro Permanente \ nAhorro Navideño \ nValor $ \ nPorcentaje % \n
Tipo de descuento: Quincenal Mensual Quincena 1 Quincena 2 AUTORIZACIONES \nAutorizo a Aranda Software , a la cual me encuentro vinculado para que deduzca de mi salario mensual , las cuotas que aquí rel aciono, los cuales deberán ser entregados a FASOFT por concepto de ahorros.\nFirma Observaciones:\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_C. C.No.",
"duration": null,
"effort": null,
"estimatedTime": 1440,
"expectedDate": 1632340067323,
"finalDate": null,
"finalStateId": 0,
"floorId": null,
"floorName": null,
"foregroundColorRgb": "255.255.255",
"groupId": 2,
"groupName": "Soporte Nivel 1",
"id": 84482,
"idByProject": "RF-84482-19-407609",
"impactId": 1,
"impactName": "[ES] BAJO",
"initialDate": null,
"initialStatus": true,
"isClosed": false,
"isVotingProcess": false,
"isimported": false,
"itemType": 4,
"itemTypeName": "Requerimiento de Servicio",
"itemVersion": 1,
"knownError": null,
"majorProblem": null,
"modelId": 31,
"modelName": "[ES] RS Servicio Soporte",
"modifiedDate": 1632253667323,
"olaId": null,
"olaName": null,
"openedDate": 1632253667323,
"parentId": null,
"parentIdByProject": null,
"parentItemType": null,
"parentItemTypeId": null,
"price": null,
"priorityId": 8,
"priorityName": "[ES] MEDIA",
"progress": 0,
"projectId": 19,
"projectName": "Soporte - ASC",
"providerId": null,
"providerName": null,
"realDate": null,
"reasonId": null,
"reasonName": null,
"receptorId": 4557,
"receptorName": "Victor Samuel Huertas Orjuela",
"registryTypeId": 7199,
"registryTypeName": "[ES] Chat",
"responsibleId": 4557,
"responsibleName": "Victor Samuel Huertas Orjuela", "riskName": null,
"serviceId": 10,
"serviceName": "Reportes",
"slaId": 1,
"slaName": "Acuerdo Soporte",
"stateId": 25,
"stateName": "Registrado",
"subject": "Test postman",
"templateId": null,
"time": 0,
"ucId": null,
"ucName": null,
"unitId": null,
"unitName": null,
"urgencyId": 5,
"urgencyName": "[ES] ALTA"
}
],
"totalItems": 36460,
"totalPage": 1
}
Parâmetros de resposta
Nome | Tipo de dado | Descrição |
---|---|---|
totalItems | Número | Número total de itens na consulta. |
Página total | Número | Número total de itens por página |
conteúdo | Lista | Lista de objetos encontrados |
closenessToExpiration | Enumerador | OnProgress = 0, (<=79) - QuaseExpirado = 1, (entre 80 e 99) - Expirado = 2 (>= 100) |
Mensagens de erro
Código | Status HTTP | Mensagem de erro |
---|---|---|
400 | Solicitação BadRequest | \r\nNome do parâmetro: TemplateId |
400 | Solicitação BadRequest | Lista de Projetos Inválidos |
400 | Solicitação BadRequest | Sem permissão |
400 | Solicitação BadRequest | Lista de tipos inválidos |
400 | Solicitação BadRequest | ProjectsListNeedsSomeArguments |
400 | Solicitação BadRequest | TypesListNeedsSomeArguments |
500 | Erro de servidor interno | FalhaGetItems |