...
pi-upatch-visualConfiguration-v1 |
Requisito | Nenhum. |
Descrição | Atualiza as configurações visuais do usuário. Obs.: Permite atualização parcial dos dados, ou seja, pode-se enviar apenas os campos que se deseja alterar. |
Parâmetros | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para a busca dos usuários: pathParams: Informar na seguinte ordem: o código do aprovador e interface. payload: Informações das configurações visuais a serem alteradas. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
Bloco de código |
---|
| {
"pathParams": [
"super",
"1"
],
"payload": {
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"initialView": 3
}
} |
|
oOutput | JsonObject | OUTPUT | Resultado da alteraçã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 alteração das configurações visuais. |
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-update-visualConfiguration-v1 |
Requisito | Nenhum. |
Descrição | Atualiza as configurações visuais do usuário. Obs.: Realiza atualização total dos dados, ou seja, se algum campo não for enviado seu conteúdo será limpo. |
Parâmetros | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para a busca dos usuários: pathParams: Informar na seguinte ordem: o código do aprovador e interface. payload: Informações das configurações visuais a serem alteradas. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
Bloco de código |
---|
| {
"pathParams": [
"super",
"1"
],
"payload": {
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"initialView": 3
}
} |
|
oOutput | JsonObject | OUTPUT | Resultado da alteraçã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 alteração das configurações visuais. |
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-query-approverUser-v1 |
Requisito | Nenhum. |
Descrição | Retorna informações de aprovadores conforme filtros informados. |
Parâmetros | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | |
do aprovadorde aprovadores: queryParams |
→ fields: - fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis
|
no oOutput.queryParams → expand: Utilizando este parâmetro com a informação "visualConfigurations", são retornadas também as configurações visuais do usuário.
pathParams: Informar o código do aprovador que se deseja buscar as informações.
Bloco de código |
---|
|
{
"pathParams": [
"super- na temp-table tt-aprovador no final desta documentação (utilizar o "Nome do objeto");
- quickSearch: Filtro rápido por código ou nome do aprovador;
- order: Ordenação (verificar campos possíveis na temp-table tt-aprovador 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;
- userCodeIni: Filtra por aprovadores com código maior ou igual ao informado;
- userCodeEnd: Filtra por aprovadores com código menor ou igual ao informado;
- userNameIni: Filtra por aprovadores com nome maior ou igual ao informado;
- userNameEnd: Filtra por aprovadores com nome menor ou igual ao informado;
- pageSize: Tamanho da página (registros que serão retornados por vez);
Bloco de código |
---|
| {
"queryParams": {
"userCodeIni": [
"ana"
],
"userCodeEnd": [
"super"
],
"order": [
"-userCode"
],
"pageSize": [
"10"
]
},
} |
|
aOutput | JsonArray | OUTPUT | Lista de aprovadores retornados na busca. 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",
"eMail": "[email protected]",
"sendEmail": true,
"receiveEmail": true,
"masterUser": true,
"currency": 0,
"automaticApproval": false,
"automaticApprovalApprover": false,
"siteCode": "1",
"allocationCode": "10702",
"releaseAmount": true,
"configuratorUser": true,
"companyCode": "10",
"language": "pt"
},
{
"userCode": "massao",
"userName": "M.Massao Matsunaka-Ger.Suprim.",
"eMail": "[email protected]",
"sendEmail": true,
"receiveEmail": true,
"masterUser": false,
"currency": 0,
"automaticApproval": true,
"automaticApprovalApprover": false,
"siteCode": "1",
"allocationCode": "",
"releaseAmount": false,
"configuratorUser": false,
"companyCode": "10",
" |
|
1]},
{
"userCode": "ana claudia",
" |
|
payload { "Ana Cludia de Oliveira",
" |
|
ordination3allCompaniestrueapproveWithoutReasontrueinitialView3}
}oOutput | JsonObject | OUTPUT | Resultado da alteraçã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,
ordination3allCompaniesautomaticApprovalApprover": |
|
trueapproveWithoutReasontrueundoTime5rightSwipeAction1leftSwipeAction2initialView3pageRecordsNumber50 |
lHasNext | LOGICAL | OUTPUT | Indica existência de mais registros para busca |
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a |
alteração das configurações visuaisbusca de aprovadores. |
Retorno | Informações |
do registro salvo de aprovadores ou erros ocorridos no processo de busca. |
Definição de temp-tables:
...