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

Валидация реакции

POST /v1/chemistry/validate

POST /v1/chemistry/validate

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

Доступ

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

Тело запроса

ПолеТипОбязательноОписание
reaction_smilesstringда
mode"strict" ∣ "training"нетПо умолчанию: "strict".
conditionsChemistryConditions ∣ nullнет
patentstring ∣ nullнет
yearinteger ∣ nullнет
include_agents_in_balancebooleanнетПо умолчанию: false.
Полная схема: ValidateReactionRequest
{
  "properties": {
    "reaction_smiles": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1,
      "title": "Reaction Smiles"
    },
    "mode": {
      "type": "string",
      "enum": [
        "strict",
        "training"
      ],
      "title": "Mode",
      "default": "strict"
    },
    "conditions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ChemistryConditions"
        },
        {
          "type": "null"
        }
      ]
    },
    "patent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 300,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Patent"
    },
    "year": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 9999,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Year"
    },
    "include_agents_in_balance": {
      "type": "boolean",
      "title": "Include Agents In Balance",
      "default": false
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "reaction_smiles"
  ],
  "title": "ValidateReactionRequest"
}

Ответы

HTTPОписаниеТип
200Успешный ответapplication/json: ReactionValidationResult
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

Ответ: ReactionValidationResult

ПолеТипОбязательноОписание
validbooleanда
mode"strict" ∣ "training"да
reaction_smilesstringда
canonical_reaction_smilesstring ∣ nullда
identity_transformationbooleanда
include_agents_in_balancebooleanда
validatorValidatorVerdictда
atom_balanceAtomConservationда
errorsChemistryIssue[]да
warningsChemistryIssue[]да
limitationsstring[]да
Полная схема
{
  "properties": {
    "valid": {
      "type": "boolean",
      "title": "Valid"
    },
    "mode": {
      "type": "string",
      "enum": [
        "strict",
        "training"
      ],
      "title": "Mode"
    },
    "reaction_smiles": {
      "type": "string",
      "title": "Reaction Smiles"
    },
    "canonical_reaction_smiles": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Canonical Reaction Smiles"
    },
    "identity_transformation": {
      "type": "boolean",
      "title": "Identity Transformation"
    },
    "include_agents_in_balance": {
      "type": "boolean",
      "title": "Include Agents In Balance"
    },
    "validator": {
      "$ref": "#/components/schemas/ValidatorVerdict"
    },
    "atom_balance": {
      "$ref": "#/components/schemas/AtomConservation"
    },
    "errors": {
      "items": {
        "$ref": "#/components/schemas/ChemistryIssue"
      },
      "type": "array",
      "title": "Errors"
    },
    "warnings": {
      "items": {
        "$ref": "#/components/schemas/ChemistryIssue"
      },
      "type": "array",
      "title": "Warnings"
    },
    "limitations": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Limitations"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "valid",
    "mode",
    "reaction_smiles",
    "canonical_reaction_smiles",
    "identity_transformation",
    "include_agents_in_balance",
    "validator",
    "atom_balance",
    "errors",
    "warnings",
    "limitations"
  ],
  "title": "ReactionValidationResult"
}

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

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

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