Executar uma query ou mutação

POSTAR /groups/{groupId}/apps/{appId}/graphql

Execute uma query ou mutação como um usuário do sistema que ignora as regras de autenticação e acesso a dados. Você pode acessar metadados sobre sua API, incluindo o esquema, com uma query de introspecção.

parâmetros de caminho

aplicação/json

corpo, corpo

  • Query string Obrigatório

    Um arquivo .graphql em string que contém uma ou mais operações válidas do GraphQL para sua API. Se mais de uma operação for definida, você deverá especificar qual operação executar no operationName.

  • variables string

    Um objeto JSON de string onde cada nome de campo mapeia um valor para uma variável na operação especificada.

  • operationName string

    O nome da operação GraphQL especificada em query para ser executada.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • de dados objeto | zero Obrigatório

      O resultado de uma operação bem-sucedida. Se null, a operação tinha erros.

    • errors array[objeto]

      Uma lista de erros encontrados ao executar uma operação.

      Erro encontrado ao executar uma operação.

      Pelo menos 1 elemento.

      Ocultar atributos de erros Mostrar atributos de erros objeto
      • mensagem string Obrigatório

        Uma mensagem que descreve o erro.

      • Localizações array[objeto] Obrigatório

        Uma lista de um ou mais locais na operação que causaram o erro.

        Os números da linha e da coluna da operação que causaram um erro.

        Ocultar atributos de localização Mostrar atributos de locais objeto
        • linha inteiro Obrigatório
        • coluna inteiro Obrigatório
POST /groups/{groupId}/apps/{appId}/GraphQL
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/graphql' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"query":"query AllTasks { tasks(query: { status: $status }) { _id owner } }","variables":"{ \"status\": \"complete\" }","operationName":"AllTasks"}'
Exemplos de solicitação
{
  "query": "query AllTasks { tasks(query: { status: $status }) { _id owner } }",
  "variables": "{ \"status\": \"complete\" }",
  "operationName": "AllTasks"
}
Exemplos de resposta (200)
{
  "data": {},
  "errors": [
    {
      "message": "string",
      "locations": [
        {
          "line": 42,
          "column": 42
        }
      ]
    }
  ]
}