CyberRXN Docs
APIAPI reference

Read one report and its review state

GET /v1/reports/{report_id}

GET /v1/reports/{report_id}

API overview · OpenAPI

Workspace-scoped by default. reviewer=true requires designated verified staff and also returns original_record and append-only events. Ordinary reports omit the raw evidence snapshot.

Authorization

This operation requires a bearer credential. The description defines additional role, scope or first-party-session restrictions; an API key does not grant those permissions by itself.

Parameters

PropertyTypeRequiredDetails
report_id (path)stringyes
reviewer (query)booleanno

Request body

No request body.

Responses

HTTPDetailsType
200Successful Responseapplication/json: ObservationReport
401Unauthorizedapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
404Not Foundapplication/problem+json: ProblemDetails
409Conflictapplication/problem+json: ProblemDetails
413Request Entity Too Largeapplication/problem+json: ProblemDetails
422Unprocessable Entityapplication/problem+json: ProblemDetails
429Too Many Requestsapplication/problem+json: ProblemDetails
502Bad Gatewayapplication/problem+json: ProblemDetails
503Service Unavailableapplication/problem+json: ProblemDetails

Response: ObservationReport

PropertyTypeRequiredDetails
idstringyes
observation_idstringyes
category"field_conflict" ∣ "stage_misattribution" ∣ "missing_source" ∣ "structure_mismatch" ∣ "other"yes
summarystringyes
evidence_quotestring ∣ nullno
proposed_patchCorrectionPatch ∣ nullno
state"pending" ∣ "accepted" ∣ "rejected" ∣ "needs_information" ∣ "needs_revalidation"yes
created_atstringyes
updated_atstringyes
referenceReportReferenceyes
reviewReviewedDecision ∣ nullno
correctionCorrectionVersion ∣ nullno
Full schema
{
  "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"
}

This page is generated from OpenAPI; examples are schemas, not a fabricated successful response.

Usage and billing · Structured errors

On this page