Árvore de páginas

Versões comparadas

Chave

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

...

pi-get-users-with-layoutSetting-v1

Requisito

Nenhum.

Descrição

Retorna a lista de usuários que layouts salvos para determinado documento

Parâmetros

Tipo

Input/Output

Descrição

oInputJsonObjectINPUT

Parâmetros para a busca dos usuários:

pathParams:  Informar na seguinte ordem: USERSWITHLAYOUT e número de documento.

Bloco de código
titleExemplo
{
  "pathParams": [
    "USERSWITHLAYOUT",
    "1"
  ],
}
oOutputJsonObjectOUTPUT

Informações dos usuários:

Bloco de código
titleExemplo
{
  "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
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de busca de usuários

Retorno

Usuários que possuem layout salvo para o documento solicitado.



pi-delete-layoutSetting

Requisito

Nenhum.

Descrição

Elimina o layout de documento de um usuário

Parâmetros

Tipo

Input/Output

Descrição

pcUserCHARACTERINPUTCódigo do usuário que se deseja eliminar o layout
piInterfaceINTEGERINPUTCódigo da interface (1 - Lista / 2 - Detalhe)
piDocumentTypeINTEGERINPUTCódigo do documento
oErrorProgress.Lang.AppErrorOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layout
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layout

Retorno

Erros ocorridos no processo de eliminação.

pi-delete-layoutSetting-v1

Requisito

Nenhum.

Descrição

Elimina o layout de documento de um usuário

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, interface e número de documento.

Bloco de código
titleExemplo
{
  "pathParams": [
    "super",
    "1",
    "2"
  ],
}
oOutputJsonObjectOUTPUT

Informações

dos usuários

do processamento:

Bloco de código
titleExemplo
{
  "status": 200,
  "payload": {
  }
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layout

Retorno

Erros ocorridos no processo de eliminação.



pi-delete-every-layoutSetting-v1

Requisito

Nenhum.

Descrição

Elimina todos os layout de documento de um usuário

Parâmetros

Tipo

Input/Output

Descrição

cUsuarioCHARACTERINPUTCódigo do usuário
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layouts

Retorno

Erros ocorridos no processo de eliminação.



pi-delete-batch-layoutSetting-v1

Requisito

Nenhum.

Descrição

Elimina layout de documento de usuário em lote

Parâmetros

Tipo

Input/Output

Descrição

oInputJsonObjectINPUT

Parâmetros para a busca dos usuários:

pathParams:  Informar na seguinte ordem: BATCH

payload: Informar o objeto com layouts a serem eliminados 

  • userCode: Código do usuário
  • interface: Interface
  • documentCode: Documento


Bloco de código
titleExemplo
{
  "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
      }
    ]
   }
}
oOutputJsonObjectOUTPUT
Informações do processamento (para cada layout):


Bloco de código
titleExemplo
{
  "batchReturn": [
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    }
  ]
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layouts

Retorno

Erros ocorridos no processo de eliminação.


Definição de temp-tables:

...