Histórico da Página
Page Tree Search |
---|
em construção.....
Objetivos
tem Tem a função de gerar fazer um pré pre processamento das ordens para que haja uma melhor velocidade para a requisição das sugestões de compra das ordens, de compra gerando sugestões de ordens de compras com o intuito de juntar 1 ou mais ordens de compra em um unico card. Essa junção é feita seguindo algumas regras especificas para que possa ser feito essa junção ao card.(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: XXXXXXXXXXXlist, detail e edit) (pi-metadata);
possui a função de trazer as regras de validação de fornecedores (pi-validate-fields);
...
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- |
---|
process (post) | ||||
---|---|---|---|---|
Requisito | Nenhum. | |||
Descrição | Repassa |
o parâmetro |
do tipo de evento |
recebido pela API de comunicação (ccp/ |
rules/ |
ordersSuggestions |
) |
para o script de negocio (ccp/rules/ordersSuggestionsRules |
) chamando o métodopi- |
process- |
v1. |
Faz pre-processamento das ordens seguindo as regras de : | |||
Parâmetro | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para busca de |
Exemplo
ordens específicos. pathParams: |
Informar: numero da ordem.
|
|
285863
|
oOutput
JsonObject
OUTPUT
Retorno da requisição trazendo as informações da ordem pesquisada
Exemplo de retorno
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
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étodopi-query-v2.Parâmetro
Tipo
Input/Output
Descrição
oInput
JsonObject
INPUT
Parâmetros para busca de ordens.
- queryParams:
- page: Informar: numero da paginação.
- pageSize informa a quantidade de campos que será retornado por cada paginação
| |||||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da finalização do pre processamento.
| ||||
Retorno | Retorna a busca dos dados da ordem |
{
"queryParams": {
"page": 1,
"pageSize
": 15
},
}
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
escolhida ou erros ocorridos durante a busca |
pi- |
---|
query | ||||
---|---|---|---|---|
Requisito | Precisa primeiro ter executado a 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 |
das sugestões passadas pelo pathParams. | |||
Parâmetro | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para busca de |
sugestões de compra. |
|
|
|
|
|
|
285863
|
| |||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações |
das sugestões de compra pesquisada
|
RowErrors
| ||||
HasNext | Logical | OUTPUT | indica se seguindo a paginação, possui mais resultados a serem mostrados\ | |
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | |
Retorno | Retorna a busca dos dados das sugestões de compra (seguindo os parâmetros page e pageSize) encontradas ou erros ocorridos durante a busca |
pi-query-orderlines | |||||
---|---|---|---|---|---|
Requisito | precisa primeiro ter executado a pi-process. | ||||
Descrição | Pega as ordens de compra atrelados a uma sugestão de compra, gerada pela pi-proces, passando os parâmetros necessários pelo pathParams e queryParams. 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-orderlines-V1. | ||||
Parâmetro | Tipo | Input/Output | Descrição | ||
oInput | JsonObject | INPUT | Parâmetros para busca das ordens de compras atreladas a uma sugestão de compra especificada.
| ||
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 baseados em uma sugestão de pedido de compra seguindo a paginação escolhida ou erros ocorridos durante a busca |
pi-metadata | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Requisito | Nenhum. | ||||||||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação (ccp/api/v1/ordersSuggestions) para o script de negocio (ccp/metadata/orderSuggetionsMetadata) chamando o métodopi-metadata-v1. Retorna os valores dos metadados associados com base nos pathParams e queryParams fornecidos. | ||||||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||||||
oInput | JsonObject | INPUT | Parâmetros requisitados para busca de metadatas.
| ||||||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo os valores do metadata pesquisada
edit
| ||||||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||||||
Retorno | Retorna a busca dos dados |
do metadata escolhido ou erros ocorridos durante a busca |
pi-validate-fields (post) | |||||||
---|---|---|---|---|---|---|---|
Requisito | Nenhum. | ||||||
Descrição | faz a conferencia se o campo messageText esta preechido, caso não, ele retornara um com json com ele preenchido corretamente Repassa o parâmetro do tipo de evento recebido pela API de comunicação (ccp/api/v1/ordersSuggestions)para o script de negocio (ccp/rules/purchaseOrderLinesV2ordersSuggestionsRules) chamando o métodopi-getvalidate-fields-v2v1. 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.
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da ordem pesquisada | ||||
Exemplo de retorno | |||||||
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 | ||||||
da ordem pesquisada
| |||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | |||||
Exemplo | |||||||
| 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 buscaCampo messageText preenchido corretamente. |