API REST

GET /v1/drives/{sg}/nodes

Lista nós do drive

GET /v1/drives/{sg}/nodes

Uma página de arquivos e pastas do security group sg, cada um com o nome decifrado (null quando este processo não tem a chave do grupo).

Parâmetros de caminho #

  • sg string obrigatório

    O security group (o drive).

Parâmetros de query #

  • exam_id string

    Só arquivos deste exame.

  • parent_id string

    Id do nó da pasta.

  • include_pending boolean

    Inclui uploads ainda não terminados.

  • limit integer

    Tamanho da página, 1–200.

  • cursor string

    O `next_cursor` da página anterior.

Respostas #

  • 200 Successful Response

    • items object[] obrigatório
    • next_cursor object
  • 400 O cofre recusou a requisição como inválida.

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 401 Sem certificado de cliente, ou a sessão do SDK foi recusada ou expirou (`session_expired`).

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 402 O workspace não tem crédito para isto.

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 403 CN não permitido, permissão negada, ou sem chave para o security group do dado (`group_key_unavailable`).

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 404 Não encontrado — também um nó lido sob um grupo ao qual não pertence.

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 409 Uma versão pendente ou mais nova, um replay, ou um upload que não chegou ao armazenamento.

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 422 O corpo ou a query falhou na validação (`invalid_request`).

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 429 Limite de taxa, depois de o backoff do SDK desistir.

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 500 Um envelope não abriu (`crypto_error`, sem detalhe de propósito).

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

  • 502 O cofre falhou, ou respondeu fora do protocolo (`protocol_error`).

    • error object obrigatório

      O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

curl --cert client.crt --key client.key \
  -X GET "https://api.imgexam.com/v1/drives/<sg>/nodes?exam_id=<string>&parent_id=<string>&include_pending=<boolean>&limit=<integer>&cursor=<string>" \
  -H "Content-Type: application/json"
{
  "items": [
    {
      "node": {
        "node_id": "string",
        "workspace_id": "string",
        "security_group_id": "string",
        "kind": "file",
        "status": "pending",
        "exam_id": {},
        "parent_id": {},
        "mode": {},
        "media_kind": {},
        "declared_size": {},
        "size": {},
        "mime_type": {},
        "encrypted_name": {
          "salt": "string",
          "nonce": "string",
          "ciphertext": "string"
        },
        "encrypted_keys": {},
        "storage_path": {},
        "optimized_variants": [
          {
            "kind": null,
            "storage_bucket": null,
            "storage_path": null,
            "storage_size": null,
            "storage_mime_type": null,
            "created_at": null
          }
        ],
        "processing_status": {},
        "processing_error": {},
        "total_size": {},
        "created_by": "string",
        "created_at": "string",
        "completed_at": {},
        "is_deleted": false
      },
      "name": {}
    }
  ],
  "next_cursor": {}
}