Pular para o conteúdo principal

Consulta JSONPath

Configuração atual da tarefa JSONPath Query no Workflow Designer

A tarefa Consulta JSONPath permite executar consultas em dados JSON utilizando expressões JSONPath. Isto é útil para extrair informações específicas de estruturas JSON complexas.

Definição de Consulta JSONPath​

Uma Consulta JSONPath é uma expressão que permite identificar e extrair dados de uma estrutura JSON navegando pelos seus elementos de forma hierárquica. Utiliza uma sintaxe semelhante aos caminhos de ficheiros para se referir a propriedades, objetos aninhados e arrays, permitindo selecionar valores específicos, coleções de elementos ou porções estruturadas do documento JSON.

Configuração​

JSON: JSON de entrada, fornecido diretamente como texto ou através de um parâmetro dinâmico (por exemplo, a saída DataExportJson da tarefa Database), não como um caminho de ficheiro, mas como conteúdo JSON direto.

Exemplo de expressão JSONPath:

$.value[?(@.name=='wmr')].type

Estrutura da Consulta​

  • $: Representa a raiz do documento JSON.
  • .value: Seleciona o elemento value diretamente sob a raiz.
  • [?(@.name=='wmr')]: Filtra os elementos do array value para incluir apenas aqueles em que o atributo name é igual a 'wmr'.
  • .type: Seleciona o atributo type dos elementos filtrados.

Exemplo de Documento JSON​

Assumindo que temos o seguinte documento JSON:

{
  "value": [
    {
      "name": "wmr",
      "type": "exampleType1"
    },
    {
      "name": "otherName",
      "type": "exampleType2"
    }
  ]
}

Resultado da Consulta​

A consulta $.value[?(@.name=='wmr')].type selecionará o valor do atributo type para o elemento em que name é 'wmr'. No nosso exemplo, o resultado será:

[
  "exampleType1"
]

Parâmetro de Saída​

Ao concluir a execução, a tarefa disponibiliza os seguintes Parâmetros de Saída, utilizáveis como entrada em tarefas subsequentes do Workflow.

  • result: Este parâmetro pode conter uma mensagem de erro ou o resultado da consulta.
  • resultJson: representa o resultado da execução da tarefa em formato JSON, incluindo informações gerais, configurações e detalhes da execução.