Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela XXX
    1. Outras Ações / Ações relacionadas
  4. Tela XXX
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. OBJETIVO

Obter informações de um centro de trabalho (também conhecido como máquina ou CT), descrição do centro de trabalho, área de produção, tipo de processador, situação, indicador se utiliza setup, grupo de máquina, tipo de apontamento de horas, número de operadores, ordem de produção atual, item atual e também o status atual da máquina (Parada, Produzindo, Em Setup e Ociosa).

02. API

MÉTODOGET
APIapi/sfc/v1/workCenter
ROTA/

03. FEW-SHOTS

De exemplos claros de perguntas que deverão ser respondidos por esse assunto (Api).

04. CONTEXTO DE API E PRODUTO

Explique para o modelo as regras de negócio e regras para execução da API, por exemplo oriente a retornar erro caso um filtro não seja informado pelo usuário.

05. CONTEXTO DE RESPOSTA

Explique para o modelo as orientações de formatação da resposta. Obs: Pode ser descrito exemplos de formatação e indicar ao modelo para segui-los.

06. PARÂMETROS

Os parâmetros definem quais as propriedades que serão utilizadas para a chamada da API. A definição dos parâmetros é obrigatório. Deve ser detalhado para que o modelo possa extrair os valores durante a conversa com o usuário. Além de definir os campos (properties), é possível definir quais destes são obrigatórios (required).

ParâmetroTipoDescriçãoObrigatório
workCenterCodestring

Código do centro de trabalho, máquina ou ct

Sim

07. GLOSSÁRIO

O glossário é um conjunto de termos utilizados para definir a tradução das propriedades retornadas no JSON da API. Além disso, os campos informados aqui serão incluídos na cláusula FIELDS da query, ou seja, somente esses campos serão retornados na resposta da API.


08. AÇÕES RELACIONADAS

São sugestões de novas perguntas ou ações que serão exibidas ao usuário após a execução desse assunto. Por exemplo, num assunto que trata de notas fiscais, uma ação relacionada poderia ser "Mostre-me as informações detalhadas do cliente dessa nota".

...