Este EndPoint pode ser utilizado para consultar informações sobre todas as solicitações de trabalho ou uma em específico.
O parâmetro "code" na url é o id da solicitação. Pode ser encontrado neste mesmo endpoint, campo id_code
GET https://app.fracttal.com/api/work_requests/{code}Parâmetros de entrada
| Parâmetro | Tipo | Obrigatório | Descrição | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
code | Texto | Opcional | Id da solicitação. Pode ser encontrado neste mesmo endpoint, campo id_code | ||||||||
since | Texto | Opcional | Data de início da consulta. Formato: 'YYYY-MM-DDTHH:MM:SS-UTC' Exemplo:'2016-07-12T20:00:00-03'. | ||||||||
until | Texto | Opcional | Data de finalização da consulta. Formato: 'YYYY-MM-DDTHH:MM:SS-UTC' Exemplo:'2016-07-12T20:00:00-03'. | ||||||||
type_date | Texto | Opcional | Tipo de data usado para filtrar a consulta. Pode ser:
| ||||||||
id_status | Texto | Opcional | Id de status da solicitação de trabalho. Os valores disponíveis são: 1 - Aberto | ||||||||
code_creator | Texto | Opcional | Código do colaborador que criou a solicitação (campo code de personnel_log). Vem NULL/vazio se o criador for um terceiro ou se a solicitação vier do Portal de Convidados (contacts_log não tem o campo code). | ||||||||
code_item | Texto | Opcional | Código do ativo/item associado à solicitação (campo code de items_log). | ||||||||
identifier | Texto | Opcional | Referência | ||||||||
page | Inteiro | Opcional | Número da página a consultar. | ||||||||
start | Inteiro | Opcional | Número do registro onde a consulta vai iniciar. Padrão 0. Todas as consultas são limitadas a 100 registros; quando houver mais que isso, usar este parâmetro para paginação. | ||||||||
limit | Inteiro | Opcional | Quantidade de registros que a requisição vai retornar. O valor padrão é 100. |
Nota sobrecode_creatorecode_itemAmbos os filtros usam
NULLIFinternamente — uma string vazia é tratada como não enviada (não filtra).code_creatorpode vir NULL na resposta quando o criador é um terceiro ou quando a solicitação se originou no Portal de Convidados, já quecontacts_lognão tem o campocode.
Parâmetros de saída
| Parâmetro | Tipo de campo | Descrição |
|---|---|---|
id_code | Texto | Id da solicitação |
date | Data UTC-0 | Data de criação da solicitação |
is_urgent | Texto | True se a solicitação é urgente, false caso contrário |
description | Texto | Descrição da solicitação |
rating | Texto | Avaliação da solicitação |
rating_notes | Texto | Notas de avaliação da aplicação |
observation | Texto | Notas da solicitação |
date_solution | Data UTC-0 | Data de solução |
types_description | Texto | Grupo |
items_description | Texto | Ativo associado à solicitação |
date_status | Texto | Data da última mudança de status |
requests_x_status_notes | Texto | Nota da mudança de status |
requests_x_status_description | Texto | Descrição do status atual |
accounts_name | Texto | Usuário que criou a solicitação |
accounts_email | Texto | Email do usuário que criou a solicitação |
requests_x_key_words_descriptions | Texto | Palavras-chave ordenadas |
wo_folio | Texto | Id da OT relacionada à solicitação |
date_incident | Data UTC-0 | Data do incidente |
parent_description | Texto | Localização do ativo associado à solicitação |
requests_x_status_accounts_name | Texto | Nome da pessoa que realizou a última mudança de status |
requested_by | Texto | Solicitado por |
types_1_description | Texto | Classificação 1 |
types_2_description | Texto | Classificação 2 |
identifier | Texto | Referência |
geolocation | Texto | Geolocalização |
id_company | Inteiro | Id interno da empresa (multi-tenancy) |
id_work_order | Inteiro | Id interno da ordem de trabalho gerada a partir da solicitação, se existir. Ver wo_folio para o folio visível |
id_type | Inteiro | Id interno do tipo de solicitação. Ver types_description |
id_item | Inteiro | Id interno do ativo/item associado à solicitação |
id_requests_x_status | Inteiro | Id interno do registro de histórico que originou o status atual |
id_type_1 | Inteiro | Id interno da classificação 1. Ver types_1_description |
id_type_2 | Inteiro | Id interno da classificação 2. Ver types_2_description |
id_personnel_log | Inteiro | Id interno do registro histórico do colaborador criador, quando o criador é colaborador interno. Vem vazio se o criador for um terceiro |
id_contacts_log | Inteiro | Id interno do registro histórico do contato terceiro criador, quando a solicitação vem do Portal de Convidados. Vem vazio se o criador for colaborador interno |
id_account | Inteiro | Id interno da conta de usuário do criador da solicitação |
id_user | Inteiro | Id do colaborador ou do contato criador, conforme o caso |
id_group_task | Inteiro | Id interno do grupo de tarefas associado ao ativo/item |
id_item_log | Inteiro | Id interno do registro histórico do ativo/item associado à solicitação |
id_priority | Inteiro | Id interno da prioridade do ativo/item associado |
id_cost_center | Inteiro | Id interno do centro de custo do ativo/item associado |
id_group | Inteiro | Id interno do grupo (nível base) do ativo/item |
id_group_1 | Inteiro | Id interno do grupo nível 1 do ativo/item |
id_group_2 | Inteiro | Id interno do grupo nível 2 do ativo/item |
id_related | Texto | Id de um elemento relacionado à solicitação. Pode vir vazio |
status_path_image | Texto | URL do ícone associado ao status atual da solicitação |
requests_x_key_words_id_key_words | Array de inteiro | Ids das palavras-chave associadas à solicitação. Complementa requests_x_key_words_descriptions |
types_color | Texto | Cor associada ao tipo de solicitação, em formato hexadecimal |
priorities_description | Texto | Descrição da prioridade do ativo/item associado |
code_item | Texto | Código do ativo/item associado à solicitação |
costs_center_description | Texto | Descrição do centro de custo do ativo/item associado |
groups_description | Texto | Descrição do grupo (nível base) do ativo/item |
groups_1_description | Texto | Descrição do grupo nível 1 do ativo/item |
groups_2_description | Texto | Descrição do grupo nível 2 do ativo/item |
requests_x_status_third_parties_name | Texto | Nome do contato terceiro que registrou a última mudança de status, se aplicável |
annotations | Objeto | Anotações internas associadas à solicitação, em formato JSON. Estrutura sujeita a mudanças |
parent_path_node | Texto | Caminho hierárquico da localização/nó pai do ativo/item associado |
code_creator | Texto | Código do colaborador que criou a solicitação. Vem vazio se o criador for um terceiro ou se a solicitação vier do Portal de Convidados |
date_maintenance | Data UTC-0 | Data de manutenção associada à solicitação |
visible_to_all | Booleano | Indica se o ativo/item associado é visível para todos os usuários |
email_requested_by | Texto | Email de quem solicitou, como campo de texto livre (independente de accounts_email) |
from_guest_portal | Booleano | Indica se a solicitação foi criada a partir do Portal de Convidados |
Exemplo:
Requisição: (GET)https://app.fracttal.com/api/work_requests/381
{
"success": true,
"message": "200",
"data": [
{
"id_code": 385,
"date": "2016-11-30T19:44:07.361543+00:00",
"is_urgent": false,
"description": "AVERIA",
"rating": null,
"rating_notes": null,
"observation": "REAPRAR",
"date_solution": null,
"types_description": "Electricidad",
"items_description": "EQUIPO PARA EJEMPLO ",
"id_status": 7,
"date_status": "2016-11-30T19:45:24.225016+00:00",
"requests_x_status_notes": "REQUEST_TODO",
"requests_x_status_description": "REQUEST_TODO",
"accounts_name": "RICARDO ROMAN",
"accounts_email": "[email protected]",
"requests_x_key_words_descriptions": "Equipo Falla., Equipo en Cliente",
"wo_folio": null,
"date_incident": "2016-11-30T16:47:03",
"parent_description": "// AMERICA/ UBICACION DE EJEMPLO/ EQUIPO PARA EJEMPLO/ ",
"requests_x_status_accounts_name": "RICARDO ROMAN",
"requested_by": "RICARDO ROMAN",
"types_1_description": "EQUIPO FALLA",
"types_2_description": "CLASIFICACIÓN 2",
"identifier": "",
"geolocation": "{\"latitude\":-33.4213982,\"longitude\":-70.60434660000001,\"hour\":\"2016-11-30 4:47 PM\",\"address\":\"San Pío X 2449, Providencia, Región Metropolitana, Chile\"}",
"id_company": 3832,
"id_work_order": null,
"id_type": 12,
"id_item": 5021,
"id_requests_x_status": 771,
"id_type_1": 4,
"id_type_2": 9,
"id_personnel_log": 158,
"id_contacts_log": null,
"id_account": 942,
"id_user": 158,
"id_group_task": null,
"id_item_log": 5044,
"id_priority": 2,
"id_cost_center": 15,
"id_group": 100,
"id_group_1": 101,
"id_group_2": 102,
"id_related": null,
"status_path_image": "https://cdn.fracttal.com/status/icons/waiting.svg",
"requests_x_key_words_id_key_words": [12, 47],
"types_color": "#F4B400",
"priorities_description": "Media",
"code_item": "EQ-0042",
"costs_center_description": "Mantenimiento General",
"groups_description": "Planta Norte",
"groups_1_description": "Área Eléctrica",
"groups_2_description": "Subestación 2",
"requests_x_status_third_parties_name": null,
"annotations": null,
"parent_path_node": "1.4.12",
"code_creator": "RROMAN",
"date_maintenance": null,
"visible_to_all": true,
"email_requested_by": "[email protected]",
"from_guest_portal": false
}
],
"total": 1
}Exemplo — filtrando por criador e ativo:
Requisição: (GET)https://app.fracttal.com/api/work_requests?code_creator=JCDIAZ&code_item=EQ-0042
{
"success": true,
"message": "200",
"data": [
{
"id_code": 3884,
"description": "PRUEBA ALEJANDRO DE ESTABILIDAD",
"items_description": "EQUIPO PARA EJEMPLO",
"id_status": 1
}
],
"total": 1
}Path Params
code — string — required
OpenAPI definition
{
"openapi": "3.1.0",
"info": {
"title": "solicitudes",
"version": "1-Es"
},
"servers": [
{
"url": "https://app.fracttal.com/api/work_requests"
}
],
"security": [
{}
],
"paths": {
"/{code}": {
"get": {
"summary": "Consulta de Solicitud",
"description": "Este EndPoint se puede utilizar para consultar información sobre todas las solicitudes de trabajo o alguna en especifico.",
"operationId": "consulta-de-solicitud",
"security": [],
"parameters": [
{
"in": "path",
"name": "code",
"schema": {
"type": "string"
},
"required": true
}
]
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": false,
"proxy-enabled": true
},
"x-readme-fauxas": true
}