CyberRXN Docs
APIAPI reference

Reaction, compound and condition nodes of one observation

GET /v1/observations/{observation_id}/graph

GET /v1/observations/{observation_id}/graph

API overview · OpenAPI

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
observation_id (path)stringyes

Request body

No request body.

Responses

HTTPDetailsType
200Successful Responseapplication/json: Graph
401Unauthorizedapplication/problem+json: ProblemDetails
402Payment Requiredapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
404Not Foundapplication/problem+json: ProblemDetails
408Request Timeoutapplication/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: Graph

PropertyTypeRequiredDetails
observation_idstringyes
nodesGraphNode[]yes
edgesGraphEdge[]yes
algorithmic_balanceImputedComponentsyes
truncatedbooleanyes
omitted_participationsintegeryes
node_limitintegeryes
product_is_role_projectionbooleanyes
Full schema
{
  "properties": {
    "observation_id": {
      "type": "string",
      "title": "Observation Id"
    },
    "nodes": {
      "items": {
        "$ref": "#/components/schemas/GraphNode"
      },
      "type": "array",
      "title": "Nodes"
    },
    "edges": {
      "items": {
        "$ref": "#/components/schemas/GraphEdge"
      },
      "type": "array",
      "title": "Edges"
    },
    "algorithmic_balance": {
      "$ref": "#/components/schemas/ImputedComponents"
    },
    "truncated": {
      "type": "boolean",
      "title": "Truncated"
    },
    "omitted_participations": {
      "type": "integer",
      "title": "Omitted Participations"
    },
    "node_limit": {
      "type": "integer",
      "title": "Node Limit"
    },
    "product_is_role_projection": {
      "type": "boolean",
      "title": "Product Is Role Projection"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "observation_id",
    "nodes",
    "edges",
    "algorithmic_balance",
    "truncated",
    "omitted_participations",
    "node_limit",
    "product_is_role_projection"
  ],
  "title": "Graph"
}

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

Usage and billing · Structured errors

On this page