Etapa do Construtor JSON

Crie uma carga JSON para usar em outra etapa. Insira valores ou use cápsulas de dados para produzir uma carga dinâmica. Esta etapa oferece suporte a vários tipos de dados, incluindo objetos e matrizes para estruturas aninhadas.

Funções e disponibilidade

Esta etapa exige uma assinatura IntegrationHub. Para obter mais informações, consulte Cronogramas jurídicos - IntegrationHub visão geral . Depois que o plug-in necessário for ativado, a etapa ficará visível em Integrações.

Disponível como uma etapa de ação de Workflow Studio. Usuários com a função action_designer podem criar uma ação personalizada com uma ou mais etapas de ação.

Entradas

Forneça um valor para cada entrada necessária para sua ação. Para adicionar valores dinâmicos, você também pode arrastar e soltar pilhas do painel de dados ou selecioná-las no seletor de pilhas.

Nome

Tipo de dados: String

Nomeie parte de um par nome-valor. Insira um valor ou use uma cápsula de dados para produzir uma carga dinâmica.

Valor

Tipo de dados: String

Parte do valor de um par nome-valor. Insira um valor ou use uma cápsula de dados para produzir uma carga dinâmica. Você pode usar uma cápsula de objeto complexo para preencher uma linha com um tipo de dados de objeto, mas isso exclui todos os secundários que a cápsula de objeto complexo já tenha.

Tipo

Tipo de dados: Choice

Tipo de dados para o par nome-valor. Se você estiver usando uma cápsula de dados para o nome ou valor, verifique se o tipo de dados da cápsula corresponde ao tipo de dados selecionado aqui. As opções são:

• Cadeia de caracteres
• Objeto
• "Number" (Número)
• Booliano
• Matriz

Para matrizes e objetos, use o ícone de adição ( ) para adicionar pares nome-valor à matriz ou objeto.

Em caso de valor vazio

Tipo de dados: Choice

Opção para especificar o que fazer se um par nome-valor tiver um valor vazio ou nulo.

• Deixe como está Mantém o valor vazio ou nulo como uma cadeia de caracteres vazia.
• Omitir propriedade Exclui um par nome-valor se o valor estiver vazio ou nulo.
• Definido como nulo Retorna um valor vazio ou nulo como um tipo de dados nulo.
• Lançar erro Retorna um erro se um par nome-valor tiver um valor vazio ou nulo.

Incluir Estruturas Externas

Tipo de dados: True/False

Opção para incluir as chaves para um contêiner JSON de nível superior.

Omitir estrutura vazia

Tipo de dados: True/False

Opção para omitir uma carga vazia. Cargas vazias podem ocorrer quando você seleciona Omitir propriedade para Em caso de valor vazio cada par nome-valor e todos os pares nome-valor na carga produzem valores vazios.

Estrutura

Tipo de dados: Structure

Carga somente leitura que a etapa produz.

Se esta etapa falhar

Tipo de dados: Choice

Opção para continuar executando a próxima etapa ou ir para a avaliação de erro. Para usar o código de status da etapa ou a mensagem para uma condição de erro de ação personalizada, consulte Avaliação de erro de ação.

Saídas

Essas saídas aparecem no painel de dados. Você pode usá-las como entradas em outro lugar em sua ação.

Saída

Tipo de dados: String

Carga JSON como uma cadeia de caracteres. Se você quiser usar a carga como um objeto, poderá usar Etapa do analisador JSON para analisar a cadeia de caracteres.

Status da etapa

Tipo de dados: Object

Cápsula de dados do objeto que contém detalhes de tempo de execução sobre a etapa. Cada etapa em uma ação retorna um Status da etapa.

Status da etapa > Código

Tipo de dados: Integer

Cápsula de dados inteiros que indica se a etapa produziu um erro. Por padrão, um valor de 1 indica que a etapa produziu um erro. Um valor 0 indica que a etapa foi executada com sucesso. Esses códigos não podem ser personalizados.

Status da etapa > Mensagem

Tipo de dados: String

Cápsula de dados da cadeia de caracteres que contém a mensagem de erro produzida pela etapa ou operação do sistema. Você não pode personalizar esta mensagem.

Gere uma carga JSON

Gere automaticamente uma carga JSON com Adicione JSON para carga botão. Este botão abre o editor de script Adicionar carga, no qual você pode inserir uma carga JSON para ser desserializada automaticamente na entrada estruturada.

Há alguns detalhes a serem considerados ao usar o gerador de carga JSON.

• Se o JSON tiver chaves vazias, a carga ainda será gerada.
• Se houver chaves duplicadas no editor de script, a última entrada de chave no objeto substituirá o valor de todas as chaves anteriores com o mesmo nome.
• Se o objeto raiz for uma matriz, a matriz raiz será encapsulada em um objeto raiz.
• Se uma matriz contiver vários objetos, todas as chaves nos objetos serão aglutinadas em um objeto primário.

O gerador de carga JSON não é compatível com o seguinte.

• cargas vazias
• tipos de objetos não complexos
• JSON inválido
• objetos raiz vazios, como uma matriz vazia
• cargas maiores que 65 000 bytes

Nota:

Gerar uma carga JSON substitui todas as estruturas existentes na etapa Construtor JSON.