Consulta de solicitação

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âmetroTipoObrigatórioDescrição
codeTextoOpcionalId da solicitação. Pode ser encontrado neste mesmo endpoint, campo id_code
sinceTextoOpcionalData de início da consulta. Formato: 'YYYY-MM-DDTHH:MM:SS-UTC' Exemplo:'2016-07-12T20:00:00-03'.
untilTextoOpcionalData de finalização da consulta. Formato: 'YYYY-MM-DDTHH:MM:SS-UTC' Exemplo:'2016-07-12T20:00:00-03'.
type_dateTextoOpcionalTipo de data usado para filtrar a consulta. Pode ser:
ValorDescrição
dateData de criação da Solicitação (Valor padrão)
date_incidentData do incidente
date_solutionData de Solução da solicitação
id_statusTextoOpcional

Id de status da solicitação de trabalho. Os valores disponíveis são:

1 - Aberto
2 - Em andamento
3 - Sistema operacional em andamento
4 - Resolvido sem OT
5 - Cancelado
6 - Resolvido com OT
7 - Aguardando uma OT
8 - OT em revisão
9 - OT cancelada
10 - Aguardando outra OT
11 - Solicitação removida de Tarefas pendentes
12 - Rejeitado
13 - Criado pelo Portal de Convidados

code_creatorTextoOpcionalCó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_itemTextoOpcionalCódigo do ativo/item associado à solicitação (campo code de items_log).
identifierTextoOpcionalReferência
pageInteiroOpcionalNúmero da página a consultar.
startInteiroOpcionalNú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.
limitInteiroOpcionalQuantidade de registros que a requisição vai retornar. O valor padrão é 100.

Nota sobre code_creator e code_item

Ambos os filtros usam NULLIF internamente — uma string vazia é tratada como não enviada (não filtra). code_creator pode vir NULL na resposta quando o criador é um terceiro ou quando a solicitação se originou no Portal de Convidados, já que contacts_log não tem o campo code.

Parâmetros de saída

ParâmetroTipo de campoDescrição
id_codeTextoId da solicitação
dateData UTC-0Data de criação da solicitação
is_urgentTextoTrue se a solicitação é urgente, false caso contrário
descriptionTextoDescrição da solicitação
ratingTextoAvaliação da solicitação
rating_notesTextoNotas de avaliação da aplicação
observationTextoNotas da solicitação
date_solutionData UTC-0Data de solução
types_descriptionTextoGrupo
items_descriptionTextoAtivo associado à solicitação
date_statusTextoData da última mudança de status
requests_x_status_notesTextoNota da mudança de status
requests_x_status_descriptionTextoDescrição do status atual
accounts_nameTextoUsuário que criou a solicitação
accounts_emailTextoEmail do usuário que criou a solicitação
requests_x_key_words_descriptionsTextoPalavras-chave ordenadas
wo_folioTextoId da OT relacionada à solicitação
date_incidentData UTC-0Data do incidente
parent_descriptionTextoLocalização do ativo associado à solicitação
requests_x_status_accounts_nameTextoNome da pessoa que realizou a última mudança de status
requested_byTextoSolicitado por
types_1_descriptionTextoClassificação 1
types_2_descriptionTextoClassificação 2
identifierTextoReferência
geolocationTextoGeolocalização
id_companyInteiroId interno da empresa (multi-tenancy)
id_work_orderInteiroId interno da ordem de trabalho gerada a partir da solicitação, se existir. Ver wo_folio para o folio visível
id_typeInteiroId interno do tipo de solicitação. Ver types_description
id_itemInteiroId interno do ativo/item associado à solicitação
id_requests_x_statusInteiroId interno do registro de histórico que originou o status atual
id_type_1InteiroId interno da classificação 1. Ver types_1_description
id_type_2InteiroId interno da classificação 2. Ver types_2_description
id_personnel_logInteiroId interno do registro histórico do colaborador criador, quando o criador é colaborador interno. Vem vazio se o criador for um terceiro
id_contacts_logInteiroId 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_accountInteiroId interno da conta de usuário do criador da solicitação
id_userInteiroId do colaborador ou do contato criador, conforme o caso
id_group_taskInteiroId interno do grupo de tarefas associado ao ativo/item
id_item_logInteiroId interno do registro histórico do ativo/item associado à solicitação
id_priorityInteiroId interno da prioridade do ativo/item associado
id_cost_centerInteiroId interno do centro de custo do ativo/item associado
id_groupInteiroId interno do grupo (nível base) do ativo/item
id_group_1InteiroId interno do grupo nível 1 do ativo/item
id_group_2InteiroId interno do grupo nível 2 do ativo/item
id_relatedTextoId de um elemento relacionado à solicitação. Pode vir vazio
status_path_imageTextoURL do ícone associado ao status atual da solicitação
requests_x_key_words_id_key_wordsArray de inteiroIds das palavras-chave associadas à solicitação. Complementa requests_x_key_words_descriptions
types_colorTextoCor associada ao tipo de solicitação, em formato hexadecimal
priorities_descriptionTextoDescrição da prioridade do ativo/item associado
code_itemTextoCódigo do ativo/item associado à solicitação
costs_center_descriptionTextoDescrição do centro de custo do ativo/item associado
groups_descriptionTextoDescrição do grupo (nível base) do ativo/item
groups_1_descriptionTextoDescrição do grupo nível 1 do ativo/item
groups_2_descriptionTextoDescrição do grupo nível 2 do ativo/item
requests_x_status_third_parties_nameTextoNome do contato terceiro que registrou a última mudança de status, se aplicável
annotationsObjetoAnotações internas associadas à solicitação, em formato JSON. Estrutura sujeita a mudanças
parent_path_nodeTextoCaminho hierárquico da localização/nó pai do ativo/item associado
code_creatorTextoCó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_maintenanceData UTC-0Data de manutenção associada à solicitação
visible_to_allBooleanoIndica se o ativo/item associado é visível para todos os usuários
email_requested_byTextoEmail de quem solicitou, como campo de texto livre (independente de accounts_email)
from_guest_portalBooleanoIndica 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
}
Path Params
string
required
Language
LoadingLoading…