CONTEÚDO


01. OBJETIVO

Retorna a lista de itens pais (produtos finais ou semiacabados) que utilizam um determinado item como componente em sua estrutura de fabricação no módulo de Engenharia do TOTVS Datasul.

A partir do código de um item componente, o assunto identifica todas as estruturas de produto (BOM – Bill of Materials) nas quais esse item aparece, retornando, mas não limitado à, os itens pais associados, bem como informações relevantes da relação, como código do item pai, descrição, referência, quantidade utilizada e roteiros, quando aplicável.

02. API

Informações da API utilizada para busca dos dados e nome do cadastro de menu relacionado à API, caso o usuário queira restringir o acesso. Mais informações: Manutenção de Programa (MEN012AA)

MÉTODOGET
API

api/enp/v1/itemStructures

ROTA/
MENU******Verificar

03. PERGUNTAS EXEMPLO (FEW-SHOTS)

Exemplos de perguntas que deverão ser respondidas por esse assunto.


Pergunta
1Quais estruturas usam o componente <código>?
2Na data de <data>, o componente <código> é válido em quais estruturas?
3O componente <código> com a Referência <código> é usado em quais estruturas?

04. PARÂMETROS

São os possíveis campos utilizados na busca dos dados pela API.

ParâmetroTipoDescriçãoObrigatório
itemCode string

Código do item

Sim

referenceCode string

Código da referência

Não

validOn string

Data de validade (deve estar válido nesta data)

Não

siteCode string

Estabelecimento

Não

productionLineCode string

Linha de produção

Não

05. 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 apresentados são incluídos na cláusula FIELDS da query, ou seja, somente esses campos são retornados na resposta da API.

PropriedadeDescriçãoTipoFormato
componentCodeItem componentQuantityComponentecharacter
componentsListCodeLista de Componentescharacter
componentQuantity

Quantidade Componente

decimal->>>>,>>>,>>9.9999
concentration

Concentração

decimal->>>>,>>>,>>9.9999
maxConcentration

Concentração Máx

decimal->>>>,>>>,>>9.9999
minConcentration

Concentração Min

decimal->>>>,>>>,>>9.9999
startDate

Data de Início

character
endDate

Data de Fim

character
itemCodeItemcharacter
isPhantomItem

Fantasma?

boolean
itemQuantity

Quantidade Item

decimal->>>>,>>>,>>9.9999
netQuantity

Quantidade Líquida

decimal->>>>,>>>,>>9.9999
usedQuantity

Quantidade Usada

decimal->>>>,>>>,>>9.9999
usesFixedQuantity

Quantidade Fixa?

decimal->>>>,>>>,>>9.9999
observation

Observação

character


position

Posição

character


referenceCodeItem

Referência do Item

character
referenceCodeComponent

Referência do Componente

character
routingCodeRoteirocharacter
sequenceSequênciainteger->>>,>>>,>>9

06. AÇÕES RELACIONADAS

São sugestões de novas perguntas ou ações que serão sugeridas ao usuário após a execução desse assunto.