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

Реакции молекулы

POST /v1/molecules/reactions

POST /v1/molecules/reactions

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

Доступ

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

Тело запроса

ПолеТипОбязательноОписание
smilesstringдаОдна молекула, без точек-разделителей.
role"reactant" ∣ "product" ∣ "agent" ∣ nullнет
limitintegerнетМаксимальное количество записей: от 1 до 100. По умолчанию: 10.
offsetintegerнетСмещение страницы, начиная с нуля. По умолчанию: 0.
Полная схема: MoleculeReactionsRequest
{
  "properties": {
    "smiles": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1,
      "title": "Smiles",
      "description": "One molecule (no dots)."
    },
    "role": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "reactant",
            "product",
            "agent"
          ]
        },
        {
          "type": "null"
        }
      ],
      "title": "Role"
    },
    "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",
  "required": [
    "smiles"
  ],
  "title": "MoleculeReactionsRequest"
}

Ответы

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. Примеры показывают схемы, а не вымышленные успешные ответы.

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

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