Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

pi-create-visualConfiguration-v1

Requisito

Nenhum.

Descrição

Cria as configurações visuais do usuário

Parâmetros

Tipo

Input/Output

Descrição

oInputJsonObjectINPUT

Parâmetros para a busca dos usuários:

payload:  Informações das configurações visuais a serem criadas.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: 

  • tt-config-visual-upd


Bloco de código
titleExemplo
{
  "payload": {
    "userCode":"super",
    "interface":1,
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}
oOutputJsonObjectOUTPUT

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
titleExemplo
{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a criação das configurações visuais.

Retorno

Informações do registro salvo ou erros ocorridos no processo.



pi-upatch-visualConfiguration-v1

Requisito

Nenhum.

Descrição

Cria

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

oInputJsonObjectINPUT

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: 

  • tt-config-visual-upd


Bloco de código
titleExemplo
{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}
oOutputJsonObjectOUTPUT

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
titleExemplo
{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}
RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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: 

  • tt-config-visual-upd


Bloco de código
titleExemplo
{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}
oOutputJsonObjectOUTPUT

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
titleExemplo
{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}
RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

Parâmetros para a busca do aprovador:

queryParams →  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
titleExemplo
{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}
oOutputJsonObjectOUTPUT

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
titleExemplo
{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a alteração das configurações visuais.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

...