Árvore de páginas

Versões comparadas

Chave

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

...

  • criação de um registro:

    Painel
    borderColor#ebecf0

    Estado
    subtletrue
    titleExemplo

    Ao chamar um método/operação para criar o cadastro de um novo usuário, o retorno pode ser o identificador (ID) do usuário gerado pelo sistema.

    Retorno da execução: 78956

  • resposta de sucesso ou falha:

    Painel
    borderColor#ebecf0

    Estado
    subtletrue
    titleExemplo

    Em operações simples, o retorno pode ser apenas um status – como sucesso ou falha – ou um código que indica o resultado da execução.

    Retorno da execução: sucesso

  • dados complexos:

    Painel
    borderColor#ebecf0

    Estado
    subtletrue
    titleExemplo

    Se o objetivo de uma operação é buscar informações de um usuário, o retorno pode ser um objeto complexo com vários campos.

    Retorno da execução: { "id": 12345, "nome": "Alonso da Cunha", "email": "[email protected]" }

  • valor calculado:

    Painel
    borderColor#ebecf0

    Estado
    subtletrue
    titleExemplo

    Uma operação pode realizar cálculos e retornar um valor como resultado, como o preço final de um pedido com base em itens, descontos e impostos, onde o retorno pode ser o valor total.

    Retorno da execução: 5000

...

Painel
borderColor#f2f2f2
bgColor#f2f2f2

Chave
Chave de identificação do parâmetro.

Valor
Valor que deve ser atribuído ao parâmetro.

Painel
borderColor#ebecf0

Estado
subtletrue
titleExemplo

Chave:

Content-Type

Valor:

application/json

Veja mais exemplos em Headers.

...

Painel
borderColor#f2f2f2
bgColor#f2f2f2

As opções disponíveis são:

  • Campo de formulário: quando selecionada, determina que o valor que será passado para o parâmetro será obtido de um campo do formulário do processo. Essa opção somente é exibida quando existe um formulário vinculado ao processo e não é exibida para parâmetros do tipo lista ou objeto;
  • Variável: quando selecionada, determina que o valor que será passado para o parâmetro será obtido de uma variável padrão da plataformaexistente no contexto do processo. Essa opção não é exibida para parâmetros do tipo lista ou objeto;
  • Nulo: quando selecionada, determina que nenhum valor será passado para esse parâmetro;
  • Fixo: quando selecionada, determina que o valor que será passado para o parâmetro é um valor fixo que será informado no componente.

...

Painel
borderColor#f2f2f2
bgColor#f2f2f2

Se a origem selecionado foi:

  • Campo de formulário: selecione o campo do formulário do processo do qual será obtido o valor que será passado para o parâmetro. São exibidos todos os campos que pertencem ao formulário vinculado ao processo;
  • Variável: selecione a variável padrão da plataforma do contexto do processo da qual será obtido o valor que será passado para o parâmetro. As variáveis disponíveis são:
    • WKCompany;
    • WKUser;
    • WKCardId;
    • WKCurrentState;
    • WKDef;
    • WKFormId;
    • WKNextState;
    • WKNumProcess;
    • WKNumState;
    • WKUserComment;
  • Fixo: informe o valor fixo que será passado para o parâmetro.

10. Se um dos parâmetros for do tipo lista ou objeto, na coluna Ação de cada parâmetro, clique em Editar Image Added para configurar os valores.

Painel
borderColor#f2f2f2
bgColor#f2f2f2

Xxxxxxxx

1109. Se um dos parâmetros for do tipo lista ou objeto, na coluna Ação de cada parâmetro, clique em Editar para configurar os valores.

Painel
borderColor#f2f2f2
bgColor#f2f2f2

Xxxxxxxx

0912. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as configurações feitas no componente Atividade de serviço.

1013. Na mensagem exibida, clique em Ok, entendi.

...