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

Статус репорта

GET /v1/reports/{report_id}

GET /v1/reports/{report_id}

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

По умолчанию — только текущее пространство. reviewer=true требует назначенного подтверждённого сотрудника и дополнительно возвращает original_record и историю добавленных событий. Обычный ответ не содержит исходный снимок доказательств.

Доступ

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

Параметры

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

Тело запроса

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

Ответы

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

Ответ: ObservationReport

ПолеТипОбязательноОписание
idstringда
observation_idstringда
category"field_conflict" ∣ "stage_misattribution" ∣ "missing_source" ∣ "structure_mismatch" ∣ "other"да
summarystringда
evidence_quotestring ∣ nullнет
proposed_patchCorrectionPatch ∣ nullнет
state"pending" ∣ "accepted" ∣ "rejected" ∣ "needs_information" ∣ "needs_revalidation"да
created_atstringда
updated_atstringда
referenceReportReferenceда
reviewReviewedDecision ∣ nullнет
correctionCorrectionVersion ∣ nullнет
Полная схема
{
  "properties": {
    "id": {
      "type": "string",
      "title": "Id"
    },
    "observation_id": {
      "type": "string",
      "title": "Observation Id"
    },
    "category": {
      "type": "string",
      "enum": [
        "field_conflict",
        "stage_misattribution",
        "missing_source",
        "structure_mismatch",
        "other"
      ],
      "title": "Category"
    },
    "summary": {
      "type": "string",
      "title": "Summary"
    },
    "evidence_quote": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Evidence Quote"
    },
    "proposed_patch": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/CorrectionPatch"
        },
        {
          "type": "null"
        }
      ]
    },
    "state": {
      "type": "string",
      "enum": [
        "pending",
        "accepted",
        "rejected",
        "needs_information",
        "needs_revalidation"
      ],
      "title": "State"
    },
    "created_at": {
      "type": "string",
      "title": "Created At"
    },
    "updated_at": {
      "type": "string",
      "title": "Updated At"
    },
    "reference": {
      "$ref": "#/components/schemas/ReportReference"
    },
    "review": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ReviewedDecision"
        },
        {
          "type": "null"
        }
      ]
    },
    "correction": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/CorrectionVersion"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "id",
    "observation_id",
    "category",
    "summary",
    "state",
    "created_at",
    "updated_at",
    "reference"
  ],
  "title": "ObservationReport"
}

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

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

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