Criando Pastas

Como criar uma pasta normal ou compartilhada com a organização.

Criando uma pasta normal

A mutation para criar uma pasta na conta do usuário autenticado (titular do token de API) é:

mutation CreateFolderMutation($folder: FolderInput!) {
  createFolder(folder: $folder) {
    id
    name
    type
    created_at
  }
}

Definindo os valores às variáveis:

{
  "folder": {
    "name": "Contratos assinados"
  }
}

E testando esta mutation no Altair:

Criando uma pasta compartilhada

Em comparação com a mutation de criar pastas, a única diferença é o parâmetro type. Portanto, usando quase a mesma mutation novamente, com o parâmetro:

mutation SharedFolderMutation(
  $folder: FolderInput!,
  $type: FolderTypeEnum
) {
  createFolder(folder: $folder, type: $type) {
    id
    name
    type
    created_at
  }
}

E passando o valor do parâmetro type dessa vez, com o valor ORGANIZATION:

{
  "folder": {
    "name": "Contratos compartilhados"
  },
  "type": "ORGANIZATION"
}

E testando no Altair fica:

Se você quer ter criar um documento em uma pasta, use o atributo folder_id na Criação do documento. Caso a intenção seja adicionar um documento existente em outra pasta já criada, veja como mover documento para uma pasta.

Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do Altair. Se você não sabe como fazer isso, confira o nosso tutorial em Usando o Altair

Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma: https://graphql.org/graphql-js/graphql-clients/

19KB

Autentique v2.postman_collection.json

Abrir

Para importar e usar no Postman