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

Поиск реакций

POST /v1/reactions/search

POST /v1/reactions/search

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

Доступ

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

Тело запроса

ПолеТипОбязательноОписание
reactantsstring ∣ nullнетПолная сторона исходных веществ: SMILES, разделённые точками.
productsstring ∣ nullнетПолная сторона продуктов: SMILES, разделённые точками.
temperature_minnumber ∣ nullнет°C; выбираются пересекающиеся интервалы.
temperature_maxnumber ∣ nullнет°C; выбираются пересекающиеся интервалы.
pressure_minnumber ∣ nullнет
pressure_maxnumber ∣ nullнет
pressure_kindstring ∣ nullнетОбозначение давления из источника: например абсолютное или манометрическое.
agentstring ∣ nullнетSMILES реагентов в поле agents; должны присутствовать все указанные молекулы.
solventstring ∣ nullнетТочное обозначение растворителя из источника.
min_balance_confidencenumber ∣ nullнетНекалиброванная оценка исходной модели SynRBL.
validated_onlybooleanнетТолько записи с положительным результатом исходной проверки. По умолчанию: true.
limitintegerнетМаксимальное количество записей: от 1 до 100. По умолчанию: 10.
offsetintegerнетСмещение страницы, начиная с нуля. По умолчанию: 0.
Полная схема: SearchReactionsRequest
{
  "properties": {
    "reactants": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 10000,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Reactants",
      "description": "Complete dot-separated reactant side (SMILES)."
    },
    "products": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 10000,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Products",
      "description": "Complete dot-separated product side (SMILES)."
    },
    "temperature_min": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Temperature Min",
      "description": "°C; matches overlapping intervals."
    },
    "temperature_max": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Temperature Max",
      "description": "°C; matches overlapping intervals."
    },
    "pressure_min": {
      "anyOf": [
        {
          "type": "number",
          "description": "Pressure in bar; negative bounds require an explicit gauge pressure_kind."
        },
        {
          "type": "null"
        }
      ],
      "title": "Pressure Min"
    },
    "pressure_max": {
      "anyOf": [
        {
          "type": "number",
          "description": "Pressure in bar; negative bounds require an explicit gauge pressure_kind."
        },
        {
          "type": "null"
        }
      ],
      "title": "Pressure Max"
    },
    "pressure_kind": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 100,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Pressure Kind",
      "description": "Source pressure label, e.g. absolute or gauge."
    },
    "agent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 10000,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent",
      "description": "Agent SMILES; every molecule must be present."
    },
    "solvent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Solvent",
      "description": "Exact source solvent label."
    },
    "min_balance_confidence": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 1,
          "minimum": 0
        },
        {
          "type": "null"
        }
      ],
      "title": "Min Balance Confidence",
      "description": "Upstream, uncalibrated SynRBL score."
    },
    "validated_only": {
      "type": "boolean",
      "title": "Validated Only",
      "description": "Only observations with a positive upstream verdict.",
      "default": true
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "description": "Maximum records, from 1 to 100.",
      "default": 10
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "title": "Offset",
      "description": "Zero-based pagination offset.",
      "default": 0
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "SearchReactionsRequest"
}

Ответы

HTTPОписаниеТип
200Успешный ответapplication/json: ObservationPage
401Требуется авторизацияapplication/problem+json: ProblemDetails
402Недостаточно кредитовapplication/problem+json: ProblemDetails
403Доступ запрещён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

Ответ: ObservationPage

ПолеТипОбязательноОписание
itemsObservation[]да
limitintegerда
offsetintegerда
has_morebooleanда
next_offsetinteger ∣ nullда
Полная схема
{
  "properties": {
    "items": {
      "items": {
        "$ref": "#/components/schemas/Observation"
      },
      "type": "array",
      "title": "Items"
    },
    "limit": {
      "type": "integer",
      "title": "Limit"
    },
    "offset": {
      "type": "integer",
      "title": "Offset"
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More"
    },
    "next_offset": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Offset"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "items",
    "limit",
    "offset",
    "has_more",
    "next_offset"
  ],
  "title": "ObservationPage"
}

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

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

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