...
| pi-query-layoutSetting-v1 |
Requisito | Nenhum. |
Descrição | Retorna informações de documentos disponíveis para configuração de layout do aprovador conforme filtros informados. |
Parâmetros | Tipo | Input/Output | Descrição |
| oInput | JsonObject | INPUT | Parâmetros para a busca de documentos: queryParams: - userCode: Código do aprovador que se deseja verificar os layouts;
- interface: Interface para qual se deseja verificar os layouts;
- fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome do objeto");
- order: Ordenação (verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome do objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
- <Nome do objeto>: Filtro pelo campo informado;
- documentCodeIni: Filtra por documentos com código maior ou igual ao informado;
- documentCodeEnd: Filtra por documentos com código menor ou igual ao informado;
| Bloco de código |
|---|
| {
"queryParams": {
"userCode": [
"super"
],
"interface": [
"1"
],
"order": [
"shortName"
]
}
} |
|
| aOutput | JsonArray | OUTPUT | Lista de documentos retornados na busca. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| Bloco de código |
|---|
| [
{
"documentCode": 5,
"documentDescription": "Cotação de Materiais",
"defaultLayout": false,
"shortName": "CO"
},
{
"documentCode": 501,
"documentDescription": "Documento Específico",
"defaultLayout": true,
"shortName": "D"
},
{
"documentCode": 1,
"documentDescription": "Solicitação de Compra - Item",
"defaultLayout": false,
"shortName": "SC"
}
]
|
|
| lHasNext | LOGICAL | OUTPUT | Indica existência de mais registros para busca |
| RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca de documentos. |
Retorno | Informações de documentos ou erros ocorridos no processo de busca. |
| pi-create-layoutSetting-v1 |
Requisito | Nenhum. |
Descrição | Cria layout de documento do usuário |
Parâmetros | Tipo | Input/Output | Descrição |
| oInput | JsonObject | INPUT | Parâmetros para criação do layout do usuário para documento: payload: Informações do layout a ser criado. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| Bloco de código |
|---|
| {
"payload": {
"userCode": "super",
"interface": 1,
" |
|
ordination3"allCompanies": true,
"fields": [
{
"id": "pend-chave-doc",
" |
|
approveWithoutReasontrueinitialView3
}
}"Chave",
"description": "Chave do Documento da Pendência de Aprovação",
"visible": true,
"size": 100
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "Valor",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 100
}
]
}
} |
|
| oOutput | JsonObject | OUTPUT | Resultado da criação do registro: Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| Bloco de código |
|---|
| {
"userCode": "super",
"userName": "Super Usuário",
"interface": 1,
"documentCode": 5,
"documentDescription": "Cotação de Materiais",
"_expandables": [
"fields"
],
"fields": [
{
"id": "pend-chave-doc",
"componentType": 1,
"label": "Chave",
"description": "Chave do Documento da Pendência de Aprovação",
"visible": true,
"size": 100
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "Valor",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 100
}
] |
|
oOutput | JsonObject | OUTPUT | Resultado da criação do registro:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| Bloco de código |
|---|
|
{
"userCode": "super",
"interface": 1,
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"undoTime": 5,
"rightSwipeAction": 1,
"leftSwipeAction": 2,
"initialView": 3,
"pageRecordsNumber": 50 |
| RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a criação das configurações visuais. |
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
Definição de temp-tables:
...
