Histórico da Página
...
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Requisito
Nenhum.
Descrição
Retorna informações de um aprovador do MLA.
Parâmetros
Tipo
Descrição
oInput
pi-get-defaults-v1 |
pi-get-document-abrev
pi-validate-user-info-v1
pi-query-app-list-v1
pi-query-pending-approval
pi-query-rejection-options-v1
pi-get-detail-pending-v1
pi-get-detail-historic-pending-v1
pi-approve-v1
pi-reprove-v1
pi-reapprove-v1
pi-process-pending-v1
Requisito | Nenhum. | |||
Descrição | Retorna dados principais para carregamento inicial do APP: empresas, estabelecimentos e documentos do aprovador com seus layouts. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
oInput |
JsonObject | INPUT | Parâmetros para a busca do aprovador: |
pathParams: Informar na seguinte ordem: getDefaults e código do aprovador. |
as opções abaixo permite retornar também as informações de:
|
|
|
|
|
|
|
|
|
|
|
|
| |||
oOutput | JsonObject | OUTPUT | Informações |
iniciais para o APP:
|
|
|
|
|
|
|
|
|
|
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
- tt-aprovador: que contém as informações principais do aprovador
- tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário.
Retorno
Aprovadores do MLA conforme filtros passados.
Requisito
Nenhum.
Descrição
Retorna layout de documento de um usuário
Parâmetros
Tipo
Descrição
Retorno
Layout do documento para o usuário e interface solicitados.
Requisito
Nenhum.
Descrição
Retorna layout de documento de um usuário
Parâmetros
Tipo
Descrição
Parâmetros para a busca do layout:
queryParams → expand: Utilizando este parâmetro com a informação "fields", são retornadas também os campos do layout.
pathParams: Informar na seguinte ordem: o código do aprovador, interface e número de documento.
Bloco de código | ||
---|---|---|
| ||
{
"queryParams": {
"expand": [
"fields"
]
},
"pathParams": [
"super",
"1",
"2"
],
} |
Informações do layout:
Bloco de código | ||
---|---|---|
| ||
{
"status": 200,
"payload": {
"userCode": "super",
"userName": "Super Usuário",
"interface": 1,
"documentCode": 2,
"documentDescription": "Solicitação de Compra - Total",
"_expandables": [
"fields"
],
"fields": [
{
"id": "doc-nr-requisicao",
"componentType": 1,
"label": "",
"description": "Número da Solicitação de Compra",
"visible": true,
"size": 100
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 100
}
}
} |
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação.:
- tt-document-com-expand: que contém as informações do documento.
- tt-layout (fields): contém as informações de campos do layout.
Retorno
Layout do documento para o usuário e interface solicitados.
Requisito
Nenhum.
Descrição
Retorna a lista de usuários que layouts salvos para determinado documento
Parâmetros
Tipo
Descrição
Parâmetros para a busca dos usuários:
pathParams: Informar na seguinte ordem: USERSWITHLAYOUT e número de documento.
Bloco de código | ||
---|---|---|
| ||
{
"payload": {
"userCode":"super",
"interface":1,
""
}
} |
Informações dos usuários:
Bloco de código | ||
---|---|---|
| ||
{
"status": 200,
"payload": {
"layoutUsers": [
{
"userCode": "super",
"userName": "Super Usuário"
},
{
"userCode": "super2",
"userName": "Super Usuário 2"
}
]
}
} |
Sobre os campos retornados:
- userCode: Código do usuário
- userName: Nome do usuário
Retorno
Usuários que possuem layout salvo para o documento solicitado.
Requisito
Nenhum.
Descrição
Elimina o layout de documento de um usuário
Parâmetros
Tipo
Descrição
Retorno
Erros ocorridos no processo de eliminação.
Requisito
Nenhum.
Descrição
Elimina o layout de documento de um usuário
Parâmetros
Tipo
Descrição
Parâmetros para a busca dos usuários:
pathParams: Informar na seguinte ordem: o código do aprovador, interface e número de documento.
Bloco de código | ||
---|---|---|
| ||
{
"pathParams": [
"super",
"1",
"2"
],
} |
Informações do processamento:
Bloco de código | ||
---|---|---|
| ||
{
"status": 200,
"payload": {
}
} |
Retorno
Erros ocorridos no processo de eliminação.
Requisito
Nenhum.
Descrição
Elimina todos os layout de documento de um usuário
Parâmetros
Tipo
Descrição
Retorno
Erros ocorridos no processo de eliminação.
Requisito
Nenhum.
Descrição
Eliminação de layouts de documento de usuário em lote
Parâmetros
Tipo
Descrição
Parâmetros para a busca dos usuários:
pathParams: Informar: BATCH
payload: Informar o objeto com layouts a serem eliminados
- userCode: Código do usuário
- interface: Interface
- documentCode: Documento
Bloco de código | ||
---|---|---|
| ||
{
"pathParams": [
"BATCH"
],
"payload": {
"layouts": [
{
"userCode":"super",
"interface":1,
"documentCode":2
},
{
"userCode":"super",
"interface":2,
"documentCode":2
},
{
"userCode":"super",
"interface":1,
"documentCode":3
},
{
"userCode":"super",
"interface":2,
"documentCode":3
}
]
}
} |
Bloco de código | ||
---|---|---|
| ||
{
"batchReturn": [
{
"status": 200,
"payload": {
}
},
{
"status": 200,
"payload": {
}
},
{
"status": 200,
"payload": {
}
},
{
"status": 200,
"payload": {
}
}
]
} |
Retorno
Erros ocorridos no processo de eliminação.
pi-create-visualConfiguration-v1 | |||||||||||||||||
Requisito | Nenhum. | ||||||||||||||||
Descrição | Cria as configurações visuais do usuário | ||||||||||||||||
Parâmetros | Tipo | Input/Output | Descrição | oInput | JsonObject | INPUT |
Bloco de código | ||
---|---|---|
| ||
{
"payload": {
"userCode":"super",
"interface":1,
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"initialView": 3
}
} |
Resultado da criação do registro:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
- tt-config-visual-upd
Bloco de código | ||
---|---|---|
| ||
{
"userCode": "super",
"interface": 1,
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"undoTime": 5,
"rightSwipeAction": 1,
"leftSwipeAction": 2,
"initialView": 3,
"pageRecordsNumber": 50
} |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
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
Descrição
Parâmetros para alteração das configurações visuis:
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:
- tt-config-visual-upd
Bloco de código | ||
---|---|---|
| ||
{
"pathParams": [
"super",
"1"
],
"payload": {
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"initialView": 3
}
} |
Resultado da alteração do registro:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
- tt-config-visual-upd
Bloco de código | ||
---|---|---|
| ||
{
"userCode": "super",
"interface": 1,
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"undoTime": 5,
"rightSwipeAction": 1,
"leftSwipeAction": 2,
"initialView": 3,
"pageRecordsNumber": 50
} |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
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
Descrição
Parâmetros para alteraação das configurações visuis:
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:
- tt-config-visual-upd
Bloco de código | ||
---|---|---|
| ||
{
"pathParams": [
"super",
"1"
],
"payload": {
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"initialView": 3
}
} |
Resultado da alteração do registro:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
- tt-config-visual-upd
Bloco de código | ||
---|---|---|
| ||
{
"userCode": "super",
"interface": 1,
"ordination": 3,
"allCompanies": true,
"approveWithoutReason": true,
"undoTime": 5,
"rightSwipeAction": 1,
"leftSwipeAction": 2,
"initialView": 3,
"pageRecordsNumber": 50
} |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
Requisito
Nenhum.
Descrição
Retorna informações de aprovadores conforme filtros informados.
Parâmetros
Tipo
Descrição
Parâmetros para a busca de aprovadores:
queryParams:
- fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis 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"
]
},
} |
Lista de aprovadores retornados na busca.
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
- tt-aprovador
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",
"language": "pt"
},
{
"userCode": "ana claudia",
"userName": "Ana Cludia de Oliveira",
"eMail": "[email protected]",
"sendEmail": false,
"receiveEmail": false,
"masterUser": false,
"currency": 0,
"automaticApproval": true,
"automaticApprovalApprover": false,
"siteCode": "a1",
"allocationCode": "",
"releaseAmount": false,
"configuratorUser": false,
"companyCode": "",
"language": "pt"
}
] |
Retorno
Informações de aprovadores ou erros ocorridos no processo de busca.
Requisito
Nenhum.
Descrição
Retorna informações de documentos disponíveis para configuração de layout do aprovador conforme filtros informados.
Parâmetros
Tipo
Descrição
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"
]
}
} |
Lista de documentos retornados na busca.
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
- tt-aprovador
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"
}
]
|
Retorno
Informações de documentos ou erros ocorridos no processo de busca.
Requisito
Nenhum.
Descrição
Cria layout de documento do usuário
Parâmetros
Tipo
Descrição
Parâmetros para criação do layout do usuário para documento:
payload: Informações do layout a ser criado:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
Bloco de código | ||
---|---|---|
| ||
{
"payload": {
"userCode": "super",
"interface": 1,
"documentCode": 5,
"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
}
]
}
} |
Resultado da criação do registro:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
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
}
]
} |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
Requisito
Nenhum.
Descrição
Criação de layout de documento do usuário em lote.
Obs: Pode ser usado para criar o layout da Listagem e Detalhe junto para o mesmo documento.
Parâmetros
Tipo
Descrição
Parâmetros para criação do layout do usuário para documento:
pathParams:Informar: BATCH
payload: Informações do layout a ser criado:
- layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
Bloco de código | ||
---|---|---|
| ||
{
"pathParams": [
"BATCH"
],
"payload": {
"layouts": [
{
"userCode": "super",
"interface": 1,
"documentCode": 5,
"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
}
]
},
{
"userCode": "super",
"interface": 2,
"documentCode": 5,
"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-cod-usuar-doc",
"componentType": 1,
"label": "Usuário",
"description": "Código do Usuário da Pendência de Aprovação",
"visible": true,
"size": 50
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "Valor",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 50
}
]
}
]
}
} |
Resultado da criação do registro:
- layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
Bloco de código | ||
---|---|---|
| ||
{
"layouts": [
{
"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
}
]
},
{
"userCode": "super",
"userName": "Super Usuário",
"interface": 2,
"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-cod-usuar-doc",
"componentType": 1,
"label": "Usuário",
"description": "Código do Usuário da Pendência de Aprovação",
"visible": true,
"size": 50
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "Valor",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 50
}
]
}
]
} |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
Requisito
Nenhum.
Descrição
Alteração de layout de documento do usuário
Parâmetros
Tipo
Descrição
Parâmetros para alteração do layout do usuário para documento:
pathParams: Informar na seguinte ordem: o código do aprovador, interface e código do documento
payload: Informações do layout a ser alterado:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
Bloco de código | ||
---|---|---|
| ||
{
"pathParams": [
"super",
"1",
"5"
],
"payload": {
"userCode": "super",
"interface": 1,
"documentCode": 5,
"fields": [
{
"id": "pend-chave-doc",
"componentType": 1,
"label": "Chave",
"description": "Chave do Documento da Pendência de Aprovação",
"visible": true,
"size": 50
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "Valor",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 50
}
]
}
} |
Resultado da criação do registro:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
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": 50
},
{
"id": "pend-valor-doc",
"componentType": 1,
"label": "Valor",
"description": "Valor da Pendência de Aprovação",
"visible": true,
"size": 50
}
]
} |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
Requisito
Nenhum.
Descrição
Alteração de layout de documento do usuário em lote.
Obs: Pode ser usado para alteração do layout da Listagem e Detalhe junto para o mesmo documento.
Parâmetros
Tipo
Descrição
Parâmetros para alteração do layout do usuário para documento:
pathParams: Informar BATCH.
payload: Informações do layout a ser criado:
- layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
Bloco de código | ||
---|---|---|
| ||
{ "pathParams": [ "BATCH" ], "payload": { "layouts": [ { "userCode": "super", "interface": 1, "documentCode": 5, "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 } ] }, { "userCode": "super "sequence": 1, "name": "Grupo de Empresas 1", "interface": 2, "documentCodecompanies": 5,[ "fields": [ { { "idcode": "pend-chave-doc002", "componentType": 1, "labelname": "Chave",TOTVS SA - E-kanban" "description": "Chave do}, Documento da Pendência de Aprovação", { "visible": true, "sizecode": 100"10", }, "name": "10 TOTVS S.A" { "id": "pend-cod-usuar-doc" }, "componentType": 1, { "labelcode": "Usuário11", "descriptionname": "TOTVS"Código do Usuário da Pendência de Aprovação", } "visible": true, } "size": 50 ], },"documents": [ { "iddocumentCode": "pend-valor-doc"1, "componentTypedocumentDescription": 1 "Solicitação de Compra - Item", "labeldefaultLayout": "Valor"false, "descriptionshortName": "Valor da Pendência de AprovaçãoSC", "visiblefields": true,[ "size": 50 { }"id": "doc-nr-requisicao", ] } ] } } |
Resultado da criação do registro:
- layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
- Mesma estrutura de campos acima
Bloco de código | ||
---|---|---|
| ||
{ "layouts": [ { "componentType": 1, "label": "", "description": "Número da Solicitação de Compra", "visible": true, "size": 100 }, { "userCodeid": "superpend-valor-doc", "userName": "Super Usuário", "interfacecomponentType": 1, "documentCodelabel": 5"", "documentDescription": "Cotação de Materiais", "_expandablesdescription": [ "Valor da Pendência de Aprovação", "fields" ], "fieldsvisible": [true, { "idsize": "pend-chave-doc", 100 "componentType": 1, } "label": "Chave", ] "description": "Chave do Documento da Pendência de Aprovação", }, { "visibledocumentCode": true5, "sizedocumentDescription": 100 "Cotação de Materiais", }, "defaultLayout": false, { "idshortName": "pend-valor-docCO", "componentTypefields": 1, [ { "label": "Valor", "descriptionid": "Valor da Pendência de Aprovação", pend-chave-doc", "visiblecomponentType": true1, "size": 100 }"label": "Chave", ] }, { "userCodedescription": "super", Chave do Documento da Pendência de "userName": "Super Usuário", Aprovação", "interface": 2, "documentCodevisible": 5true, "documentDescription": "Cotação de Materiais", "_expandablessize": [100 "fields" ]}, "fields": [ { "id": "pend-chavevalor-doc", "componentType": 1, "label": "ChaveValor", "description": "ChaveValor do Documento da Pendência de Aprovação", "visible": true, "size": 100 } ] }, {], "idestablishments": "pend-cod-usuar-doc",[ "componentType": 1, { "labelcode": "UsuárioA1", "descriptionname": "Código do Usuário da Pendência de AprovaçãoEstabelecimento TOTVS", "visiblecodeCompany": true,"10" "size": 50 }, }, { "id": "pend-valor-doc", "componentTypecode": 1"10000", "labelname": "ValorEstab 10000", "descriptioncodeCompany": "10"Valor da Pendência de Aprovação", } "visible": true, ] "size": 50 } ] } ] } |
Retorno
Informações do registro salvo ou erros ocorridos no processo.
Definição de temp-tables:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados | |
Retorno | Dados principais para inicialização do APP ou erros ocorridos durante o processo de busca. |
pi-get-document-abrev
pi-validate-user-info-v1
pi-query-app-list-v1
pi-query-pending-approval
pi-query-rejection-options-v1
pi-get-detail-pending-v1
pi-get-detail-historic-pending-v1
pi-approve-v1
pi-reprove-v1
pi-reapprove-v1
pi-process-pending-v1
Definição de temp-tables:
RowErrors |
RowErrors
Entrada/Saída
Temp-table com dados dos erros ocorridos durante o processo
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
ErrorSequence
INTEGER
Sim
Não se aplica
ErrorNumber
Sim
Não se aplica
Entrada/Saída | ||||
Temp-table com dados dos |
erros ocorridos durante o processo | Saída | |||
Atributo |
Tipo
Descrição
Obrigatório
Evolução
cod-usuar
CHARACTER
Não
Não se aplica
nome-usuar
Não
Não se aplica
Tipo | Descrição | Obrigatório | Evolução | |
ErrorSequence | INTEGER | Número da sequência do erro | Sim |
Não se aplica |
ErrorNumber |
INTEGER |
Código do erro | Sim | Não |
se aplica |
ErrorDescription |
CHARACTER |
Descrição do erro | Sim |
Não se aplica |
ErrorParameters |
CHARACTER | Parâmentros da mensagem de erro | Sim |
Não se aplica |
ErrorType | CHARACTER |
Tipo do |
erro |
Sim | Não se aplica |
ErrorHelp |
CHARACTER | Texto de ajuda da mensagem de erro | Sim |
Não se aplica |
ErrorSubType | CHARACTER | Subtipo do erro | Sim |
Não se aplica |
tt- | estabelaprovador | siteCode | CHARACTER | Estabelecimento do aprovador | Não | Não se aplica | ||||||||
cod-lotacao | allocationCode | CHARACTER | Lotação do aprovador | Não | Não se aplica | |||||||||
Entrada/Saída | ||||||||||||||
Temp-table com dados dos aprovadores | Saída | |||||||||||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução | |||||||||
cod-usuar | userCode | CHARACTER | Código do aprovador | libera-verba | releaseAmount | LOGICAL | Indica se o aprovador libera verbaNão | Não se aplica | log||||||
nome-usuar | -configconfiguratorUseruserName | LOGICAL | Indice se o aprovador é configurador visualCHARACTER | Nome do aprovador | Não | Não se aplica | ||||||||
empresae-mail | companyCodeeMail | CHARACTER | Empresa E-mail do aprovador | Não | Não se aplica | |||||||||
idiomaenvia-email | languagesendEmail | CHARACTER | LOGICAL | Indica se envia e-mailIdioma do aprovador | Não | Não se aplica |
tt-config-visual
Entrada/Saída
Temp-table com dados de configurações visuais de aprovadores
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
recebe-email | receiveEmail | LOGICAL | Indica se recebe e-mail | Não | Não se aplica |
usuar-mestre | masterUser | LOGICAL | Indica se o usuário é mestre | Não | Não se aplica |
mo-codigo | currency | INTEGER | Moeda |
cod-usuar
CHARACTER
do aprovador | Não | Não se aplica |
sigla- |
moeda |
currencyAbbrev |
Ordenação padrão:
(1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)
CHARACTER | Sigla da moeda do usuário | Não | Não se aplica |
aprova-auto | automacticApproval | LOGICAL | Indica |
se o aprovador aprova automaticamente | Não | Não se aplica |
aprova- |
auto- |
aprov |
automacticApprovalApprover | LOGICAL | Indica |
se o aprovador aprova automaticamente pendências do aprovador | Não | Não se aplica |
cod- |
estabel |
siteCode |
CHARACTER | Estabelecimento do aprovador | Não | Não se aplica |
cod-lotacao | allocationCode | CHARACTER | Lotação do aprovador | Não |
Ação do swipe (Direito)
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)Não se aplica |
libera-verba | releaseAmount | LOGICAL | Indica se o aprovador libera verba |
Ação do swipe (Esquerdo)
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)Não | Não se aplica |
log- |
usuar-config | configuratorUser | LOGICAL | Indice se o aprovador é configurador visual | Não | Não se aplica |
empresa | companyCode | CHARACTER | Empresa do aprovador |
Visualização inicial
(1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)Não | Não se aplica |
idioma | language | CHARACTER | Idioma do aprovador | Não | Não se aplica |
tt-config-visual-upd | Entrada/Saída | |||||||||
Temp-table com dados de configurações visuais de aprovadores | Saída | |||||||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução | |||||
cod-usuar | userCode | CHARACTER | Código do aprovador | Sim | Não se aplica | |||||
cod-usuar | CHARACTER | Código do aprovador | Não | idi-interfac | idi-interfac | INTEGER | Interface | SimNão se aplica | ||
idi-ordenacao | ordination | INTEGER | Ordenação padrão: (1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento) | Não | Não se aplica | |||||
log-mostra-todas-empresas | allCompanies | LOGICAL | Indica apresentação de pendências de todas as empresas | Não | Não se aplica | |||||
log-aprova-sem-motiv | approveWithoutReason | LOGICAL | Indica aprovação sem informar motivo | Não | Não se aplica | |||||
cdn-tempo-desf | undoTime | INTEGER | Tempo de desfazer | Não | Não se aplica | |||||
idi-acao-swip-dire | rightSwipeAction | INTEGER | Ação do swipe (Direito) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não se aplica | ||||||
idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não | Não se aplica | |||||
idi-visualiz-inicial | initialView | INTEGER | Visualização inicial (1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre) | Não | Não se aplica | |||||
num-registro-paginac | pageRecordsNumber | INTEGER | Número de registros por página | Não | Não se aplica |
ttCompany | Entrada/Saída | ||||
Temp-table com dados de |
empresas | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
seqGroup |
INTEGER |
CHARACTER
Sequência da empresa | Sim | Não se aplica |
cCode |
code |
CHARACTER | Código da empresa | Sim | Não se aplica |
cName | name | CHARACTER | Nome da empresa | Sim | Não se aplica |
ttEstablishments | Entrada/Saída | ||||
Temp-table com dados de estabelecimentos | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cCode | code | CHARACTER | Código do estabelecimento | Sim |
Não se aplica |
cName |
name |
CHARACTER | Nome do estabelecimento | Sim |
Não se aplica |
cCodeCompany |
codeCompany | CHARACTER |
Código da empresa | Sim |
Não se aplica. |
tt-document |
Entrada/Saída | |||||
Temp-table com dados de documentos | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | userCode | CHARACTER | Código do aprovador | Sim | Não se aplica |
nome-usuar
Nome do aprovador
Não
Não se aplica
idi-interfac | interface | INTEGER | Interface (1 - Lista / 2 - Detalhe) | Sim | Não se aplica |
cod-tip-doc | documentCode | INTEGER | Código do documento | Sim | Não se aplica |
desc-tip-doc | documentDescription | CHARACTER | Descrição do documento | Não | Não se aplica |
layout-padrao | defaultLayout | LOGICAL | Layout padrão | Não | Não se aplica |
sigla | shortName | CHARACTER | Sigla do documento | Não | Não se aplica |
tt-layout | Entrada/Saída | ||||
Temp-table com campos de layout | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cdn-docto | INTEGER | Código do documento | Sim | Não se aplica | |
cod-usuar | CHARACTER | Código do aprovador | Sim | Não se aplica | |
idi-interfac | INTEGER | Interface (1 - Lista / 2 - Detalhe) | Sim | Não se aplica | |
cod-id-campo | id | CHARACTER | Identificador do campo | Sim | Não se aplica |
idi-compon | componentType | INTEGER | Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador) | Sim | Não se aplica |
nom-rotu-campo | label | CHARACTER | Rótulo do campo | Não | Não se aplica |
des-campo | description | CHARACTER | Descrição do campo | Sim | Não se aplica |
log-visivel | visible | LOGICAL | Visibilidade do campo | Sim | Não se aplica |
cdn-tamanho | size | INTEGER | Tamanho do campo | Sim | Não se aplica |
cdn-ord | INTEGER | Ordem do campo | Sim | Não se aplica | |
cod-entid-pai | CHARACTER | Identificação da entidade pai | Não | Não se aplica | |
Índice: visivel-ordem, log-visivel, cdn-ord |