diagnos

API REST

GET /v1/exams

Lista exames

Publicado a partir do commit 4eb9d27
GET /v1/exams

Uma página de exames; as linhas são anônimas a menos que summary=true.

Parâmetros de query #

  • security_group string

    Só este security group (padrão: todo grupo que este processo pode listar).

  • include_deleted boolean

    Inclui documentos na lixeira.

  • limit integer

    Tamanho da página, 1–200.

  • cursor string

    O `next_cursor` da página anterior.

  • summary boolean

    Inclui o resumo decifrado de cada linha (nomes/tags, ou título/modalidade/data).

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/exams?security_group=<string>&include_deleted=<boolean>&limit=<integer>&cursor=<string>&summary=<boolean>" \
  -H "Content-Type: application/json"
 
{
  "items": [
    {
      "index": {
        "document_id": "string",
        "workspace_id": "string",
        "resource": "patients",
        "security_group_id": "string",
        "encrypted_keys": {},
        "encrypted_index": {},
        "streams": {},
        "meta": {},
        "created_at": "string",
        "created_by": "string",
        "updated_at": "string",
        "updated_by": {},
        "is_archived": false,
        "is_deleted": false
      },
      "summary": {}
    }
  ],
  "next_cursor": {}
}