Objetivos
tem a função de gerar um pré processamento das ordens para que haja uma melhor velocidade para a requisição das sugestões de compra das ordens, (pi-process);
possuem a função de pegar os metadatas das apresentação dos dados no front-end haver com as sugestões de compra (sendo eles: XXXXXXXXXXX) (pi-metadata);
possui a função de trazer as regras de validação de fornecedores (pi-validate-fields);
possui a função de trazer as ordens de compras atrelas a uma sugestão criada pelo process (pi-query-orderlines);
possui a função de trazer os valores das sugestões que foram geradas no process (por padrão o valor é 15 mas pode ser alterado pelo (COISALEGAL) ) (pi-query).
Funcionalidade
A API fornece uma série de métodos que podem ser executados individualmente para apresentação das informações da(s) sugestões de compra.
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-query | |||||||
|---|---|---|---|---|---|---|---|
| Requisito | precisa primeiro ter rodado o pi-process | ||||||
Descrição | Repassa os parâmetro da requisição (do tipo de evento) recebido pela API de comunicação (ccp/api/v1/ordersSuggestions.p) para o script de negocio (ccp/rules/ordersSuggestionsRules.p) chamando o método pi-query-orderlines-v1. Retornando os valores da sugestão passada pelo pathParams. | ||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | Parâmetros para busca de sugestoes de compra. pathParams: deve se ter 3 valores para que possa ser feito a busca corretamente d
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da ordem pesquisada
| ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||
Retorno | Retorna a busca dos dados da ordem escolhida ou erros ocorridos durante a busca | ||||||
pi-query-orderlines | |||||
|---|---|---|---|---|---|
| Requisito | Nenhum. | ||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-query-v2. | ||||
Parâmetro | Tipo | Input/Output | Descrição | ||
oInput | JsonObject | INPUT | Parâmetros para busca de ordens.
| ||
oOutput | JsonObject | OUTPUT | Retorno contendo o as informações de todos as ordens na paginação escolhida: | ||
lHasNext, | number | OUTPUT | Informa um valor booleano se tem ou não uma próxima pagina | ||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||
Retorno | Retorna uma busca das ordens seguindo a paginação escolhida ou erros ocorridos durante a busca | ||||
pi-metadata | |||||||
|---|---|---|---|---|---|---|---|
| Requisito | |||||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-get-v2. Retornando os valores da ordem passada pelo pathParams. | ||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | Parâmetros para busca de ordens específicos. pathParams: Informar: numero da ordem. queryParams: pode ser utilizado filtros complexos com campos específicos.
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da ordem pesquisada
| ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||
Retorno | Retorna a busca dos dados da ordem escolhida ou erros ocorridos durante a busca | ||||||
pi-validate-fields | |||||||
|---|---|---|---|---|---|---|---|
| Requisito | |||||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-get-v2. Retornando os valores da ordem passada pelo pathParams. | ||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | Parâmetros para busca de ordens específicos. pathParams: Informar: numero da ordem. queryParams: pode ser utilizado filtros complexos com campos específicos.
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da ordem pesquisada
| ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||
Retorno | Retorna a busca dos dados da ordem escolhida ou erros ocorridos durante a busca | ||||||
pi-process | |||||||
|---|---|---|---|---|---|---|---|
| Requisito | |||||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-get-v2. Retornando os valores da ordem passada pelo pathParams. | ||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | Parâmetros para busca de ordens específicos. pathParams: Informar: numero da ordem. queryParams: pode ser utilizado filtros complexos com campos específicos.
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da ordem pesquisada
| ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||
Retorno | Retorna a busca dos dados da ordem escolhida ou erros ocorridos durante a busca | ||||||