CyberRXN Docs
APIСправочник API

Полная запись источника

GET /v1/observations/{observation_id}

GET /v1/observations/{observation_id}

Все операции API · OpenAPI

Доступ

Требуется bearer-авторизация. Описание операции задаёт дополнительные права, роли и ограничения для сессий кабинета. Сам по себе API-ключ их не предоставляет.

Параметры

ПолеТипОбязательноОписание
observation_id (path)stringда
include_raw (query)booleanнет

Тело запроса

Тело запроса не требуется.

Ответы

HTTPОписаниеТип
200Успешный ответapplication/json: ObservationDetail
401Требуется авторизацияapplication/problem+json: ProblemDetails
402Недостаточно кредитовapplication/problem+json: ProblemDetails
403Доступ запрещёнapplication/problem+json: ProblemDetails
404Не найденоapplication/problem+json: ProblemDetails
408Время запроса истеклоapplication/problem+json: ProblemDetails
413Превышен размер запросаapplication/problem+json: ProblemDetails
422Ошибка входных данныхapplication/problem+json: ProblemDetails
429Превышен лимитapplication/problem+json: ProblemDetails
502Ошибка шлюзаapplication/problem+json: ProblemDetails
503Сервис недоступенapplication/problem+json: ProblemDetails

Ответ: ObservationDetail

ПолеТипОбязательноОписание
dataset_revisionstring ∣ nullнетВерсия неизменяемого снимка корпуса.
record_digeststring ∣ nullнетSHA-256 исходной записи и нормализованного научного содержания; не меняется при добавлении других записей в корпус.
observation_idstringда
reaction_idstring ∣ nullда
reaction_smilesstring ∣ nullда
conditionsConditionsда
evidenceEvidenceда
validationValidationда
balancingBalancingда
original_reaction_smilesstring ∣ nullда
rebalanced_reaction_smilesstring ∣ nullда
imputed_componentsImputedComponentsда
sourceSourceда
paragraph_textstring ∣ nullда
raw_metadataobject ∣ nullнетТолько при include_raw=true.
Полная схема
{
  "properties": {
    "dataset_revision": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dataset Revision",
      "description": "Immutable corpus snapshot revision."
    },
    "record_digest": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        {
          "type": "null"
        }
      ],
      "title": "Record Digest",
      "description": "SHA-256 of source-record and normalized scientific semantics; stable across corpus appends."
    },
    "observation_id": {
      "type": "string",
      "title": "Observation Id"
    },
    "reaction_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reaction Id"
    },
    "reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reaction Smiles"
    },
    "conditions": {
      "$ref": "#/components/schemas/Conditions"
    },
    "evidence": {
      "$ref": "#/components/schemas/Evidence"
    },
    "validation": {
      "$ref": "#/components/schemas/Validation"
    },
    "balancing": {
      "$ref": "#/components/schemas/Balancing"
    },
    "original_reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Original Reaction Smiles"
    },
    "rebalanced_reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Rebalanced Reaction Smiles"
    },
    "imputed_components": {
      "$ref": "#/components/schemas/ImputedComponents"
    },
    "source": {
      "$ref": "#/components/schemas/Source"
    },
    "paragraph_text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Paragraph Text"
    },
    "raw_metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Raw Metadata",
      "description": "Only with include_raw=true."
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "observation_id",
    "reaction_id",
    "reaction_smiles",
    "conditions",
    "evidence",
    "validation",
    "balancing",
    "original_reaction_smiles",
    "rebalanced_reaction_smiles",
    "imputed_components",
    "source",
    "paragraph_text"
  ],
  "title": "ObservationDetail"
}

Эта страница генерируется из OpenAPI. Примеры показывают схемы, а не вымышленные успешные ответы.

Расход и оплата · Типизированные ошибки

На этой странице