Skip to content

Commit

Permalink
HubSoft updated postman_doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hubsoftbrasil committed Nov 24, 2022
1 parent e2a7b58 commit 8996d88
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions Postman Collections/postman_doc.json
Original file line number Diff line number Diff line change
Expand Up @@ -1736,6 +1736,15 @@
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"consulta\":\"Guilherme\",\n \"data_inicio\":\"2020-11-01 00:00:00\",\n \"data_fim\":\"2020-11-20 23:59:59\",\n \"tipo_data\":\"data_inicio_programado\",\n \"order_by_key\":\"asc\",\n \"order_by\":\"data_inicio_programado\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": "{{url}}/api/v1/integracao/ordem_servico/consultar",
"description": "**Endpoint (Rota)**\n\nNeste `endpoint`, será possível consultar ordens de serviço, obtendo o retorno no formato `JSON` como resposta. Os seguintes parâmetros podem/devem ser utilizados:\n\n| Atributo | Descrição | Obrigatório |\n| --- | --- | --- |\n| consulta | Parametro que será utilizado para encontrar uma O.S. pelo seu número ou nome do cliente | Sim |\n| data_inicio | Data inicial de referência para consulta de ordens de serviço em um intervalo | Sim |\n| data_fim | Data final de referência para consulta de ordens de serviço em um intervalo | Sim |\n| tipo_data | O tipo de data poderá ser: data_cadastro, data_inicio_programado, data_inicio_executado, data_termino_programado, data_termino_executado | Não |\n| order_by | A ordenação poderá ser: data_cadastro, data_inicio_programado, data_inicio_executado, data_termino_programado, data_termino_executado | Não |\n| order_by_key | A ordenação poderá ser: crescente (ASC) ou decrescenter (DESC) | Não |\n\nOs atributos podem conter os seguintes valores:\n\n| Atributo | Descrição | Valor Default |\n| --- | --- | --- |\n| id_ordem_servico | Número Inteiro | Nenhum |\n| consulta | Texto ou número inteiro | Nenhum |\n| status | status da O.S | pendente , finalizado ou aguardando_agendamento |\n| data_inicio | Formato timestamp (2020-01-01 00:00:00) | Nenhum |\n| data_fim | Formato timestamp (2020-01-01 00:00:00) | Nenhum |\n| tipo_data | Texto | data_inicio_programado |\n| order_by | Texto | data_inicio_programado |\n| order_by_key | Texto | desc |\n\nVeja que os parâmetros enviados na requisição `POST` devem obedecer a estrutura no formato `JSON`:\n\n```\n{\n \"consulta\": \"Guilherme\",\n \"data_inicio\": \"2020-11-01 00:00:00\",\n \"data_fim\": \"2020-11-20 23:59:59\",\n \"tipo_data\": \"data_inicio_programado\",\n \"order_by_key\": \"asc\",\n \"order_by\": \"data_inicio_programado\"\n}\n\n```"
},
Expand Down Expand Up @@ -3324,37 +3333,37 @@
],
"variable": [
{
"id": "cfd96426-fc23-4d12-8bec-7a1914aec3c5",
"id": "5a5e40ae-eb63-4275-a8bd-3882750710ad",
"key": "url",
"value": ""
},
{
"id": "7acc747c-d22a-4aae-b7d2-9786f28fda97",
"id": "ca8f9771-1532-4c4f-a2d5-44afa08bd680",
"key": "client_id",
"value": ""
},
{
"id": "7972bac9-742a-43ff-8d1a-c234f334ba08",
"id": "889e22a2-6356-4438-b8ed-dbe0ece95b02",
"key": "client_secret",
"value": ""
},
{
"id": "44346953-baa2-4651-adab-c0406fdef082",
"id": "a0f81cd1-28f6-4dc2-afe8-1efb96fccf72",
"key": "username",
"value": ""
},
{
"id": "f0557b90-205b-464d-97fa-f19fc6344869",
"id": "d606e506-4438-4615-b5e7-92cdfff49963",
"key": "password",
"value": ""
},
{
"id": "600f0f45-33c5-423d-88cb-b3d8ecaf487d",
"id": "3962592d-b9fa-4f7d-9db5-aea3a9b89810",
"key": "grant_type",
"value": ""
},
{
"id": "cd0c3cdf-2400-4a56-a22f-b94204ec51d9",
"id": "aacc2176-687d-498e-bb5e-90cba12cac94",
"key": "access_token",
"value": ""
}
Expand Down

0 comments on commit 8996d88

Please sign in to comment.