Accepts TRAPI Queries.
POSThttps://robokop-automat.apps.renci.org/reactome/query
Accepts a TRAPI Query and returns a TRAPI Response. (https://github.com/NCATSTranslator/ReasonerAPI/)
Schema
Request
Query Parameters
Default value: true
- application/json
Body
required
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- OperationAnnotate
- OperationAnnotateEdges
- OperationAnnotateNodes
- OperationBind
- OperationCompleteResults
- OperationEnrichResults
- OperationFill
- OperationFilterKgraph
- OperationFilterKgraphContinuousKedgeAttribute
- OperationFilterKgraphDiscreteKedgeAttribute
- OperationFilterKgraphDiscreteKnodeAttribute
- OperationFilterKgraphOrphans
- OperationFilterKgraphPercentile
- OperationFilterKgraphStdDev
- OperationFilterKgraphTopN
- OperationFilterResults
- OperationFilterResultsTopN
- OperationLookup
- OperationLookupAndScore
- OperationOverlay
- OperationOverlayComputeJaccard
- OperationOverlayComputeNgd
- OperationOverlayConnectKnodes
- OperationOverlayFisherExactTest
- OperationRestate
- OperationScore
- OperationSortResults
- OperationSortResultsEdgeAttribute
- OperationSortResultsNodeAttribute
- OperationSortResultsScore
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- FillAllowParameters
- FillDenyParameters
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- ]
message object
Message.
query_graph objectnullable
Query graph.
nodes objectrequired
Custom class that implements MutableMapping and is hashable
property name* query-graph node
Query node.
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: Value must match regular expression ^biolink:[A-Z][a-zA-Z]*$
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [BATCH
, ALL
, MANY
]
Default value: BATCH
Enumeration for set interpretation.
constraints object[]
Custom class that implements MutableSequence and is hashable
Default value: false
Possible values: [==
, ===
, >
, <
, matches
]
Operator.
Default value: [object Object]
Custom class that implements MutableSequence and is hashable
edges objectrequired
Custom class that implements MutableMapping and is hashable
property name* query-graph edge
Query edge.
Possible values: [lookup
, inferred
]
Knowledge Type.
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
Default value: ``
Custom class that implements MutableSequence and is hashable
attribute_constraints object[]
Custom class that implements MutableSequence and is hashable
Default value: false
Possible values: [==
, ===
, >
, <
, matches
]
Operator.
qualifier_constraints object[]
Custom class that implements MutableSequence and is hashable
qualifier_set object[]
Custom class that implements MutableSequence and is hashable
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
knowledge_graph objectnullable
Knowledge graph.
nodes objectrequired
Custom class that implements MutableMapping and is hashable
property name* knowledge-graph node
Knowledge graph node.
Possible values: Value must match regular expression ^biolink:[A-Z][a-zA-Z]*$
Default value: ``
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
edges objectrequired
Custom class that implements MutableMapping and is hashable
property name* knowledge-graph edge
Knowledge graph edge.
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
sources object[]required
Custom class that implements MutableSet and is hashable
Possible values: [aggregator_knowledge_source
, primary_knowledge_source
, supporting_data_source
]
Types of resources
Default value: ``
Custom class that implements MutableSet and is hashable
Default value: ``
Custom class that implements MutableSet and is hashable
qualifiers object[]nullable
Custom class that implements MutableSet and is hashable
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
results object[]nullable
Results.
node_bindings objectrequired
Custom class that implements MutableMapping and is hashable
property name* HashableSet[NodeBinding]
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
analyses object[]required
Custom class that implements MutableSet and is hashable
edge_bindings objectrequired
Custom class that implements MutableMapping and is hashable
property name* HashableSet[EdgeBinding]
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
auxiliary_graphs objectnullable
Auxiliary Graphs
property name* auxiliary graphnullable
Auxiliary Graph
Default value: ``
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
Log level.
workflow object[]
Custom base model for all classes
This provides hash and equality methods.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [annotate
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [annotate_edges
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [annotate_nodes
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [bind
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [complete_results
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [enrich_results
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Possible values: <= 1
Default value: 0.000001
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [fill
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_continuous_kedge_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [above
, below
]
'above' or 'below'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_discrete_kedge_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_discrete_knode_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_orphans
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_percentile
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: <= 100
Default value: 95
'above' or 'below'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_std_dev
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
'plus' or 'minus'.
Default value: 1
'above' or 'below'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_top_n
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: 50
'top' or 'bottom'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_results
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_results_top_n
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [lookup
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [lookup_and_score
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_compute_jaccard
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_compute_ngd
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_connect_knodes
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_fisher_exact_test
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [restate
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [score
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results_edge_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [ascending
, descending
]
'ascending' or 'descending'.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results_node_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [ascending
, descending
]
'ascending' or 'descending'.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results_score
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [ascending
, descending
]
'ascending' or 'descending'.
Responses
- 200
- 400
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- OperationAnnotate
- OperationAnnotateEdges
- OperationAnnotateNodes
- OperationBind
- OperationCompleteResults
- OperationEnrichResults
- OperationFill
- OperationFilterKgraph
- OperationFilterKgraphContinuousKedgeAttribute
- OperationFilterKgraphDiscreteKedgeAttribute
- OperationFilterKgraphDiscreteKnodeAttribute
- OperationFilterKgraphOrphans
- OperationFilterKgraphPercentile
- OperationFilterKgraphStdDev
- OperationFilterKgraphTopN
- OperationFilterResults
- OperationFilterResultsTopN
- OperationLookup
- OperationLookupAndScore
- OperationOverlay
- OperationOverlayComputeJaccard
- OperationOverlayComputeNgd
- OperationOverlayConnectKnodes
- OperationOverlayFisherExactTest
- OperationRestate
- OperationScore
- OperationSortResults
- OperationSortResultsEdgeAttribute
- OperationSortResultsNodeAttribute
- OperationSortResultsScore
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- FillAllowParameters
- FillDenyParameters
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- RunnerAllowList
- RunnerDenyList
- RunnerTimeout
- ]
message object
Message.
query_graph objectnullable
Query graph.
nodes objectrequired
Custom class that implements MutableMapping and is hashable
property name* query-graph node
Query node.
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: Value must match regular expression ^biolink:[A-Z][a-zA-Z]*$
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [BATCH
, ALL
, MANY
]
Default value: BATCH
Enumeration for set interpretation.
constraints object[]
Custom class that implements MutableSequence and is hashable
Default value: false
Possible values: [==
, ===
, >
, <
, matches
]
Operator.
Default value: [object Object]
Custom class that implements MutableSequence and is hashable
edges objectrequired
Custom class that implements MutableMapping and is hashable
property name* query-graph edge
Query edge.
Possible values: [lookup
, inferred
]
Knowledge Type.
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
Default value: ``
Custom class that implements MutableSequence and is hashable
attribute_constraints object[]
Custom class that implements MutableSequence and is hashable
Default value: false
Possible values: [==
, ===
, >
, <
, matches
]
Operator.
qualifier_constraints object[]
Custom class that implements MutableSequence and is hashable
qualifier_set object[]
Custom class that implements MutableSequence and is hashable
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
knowledge_graph objectnullable
Knowledge graph.
nodes objectrequired
Custom class that implements MutableMapping and is hashable
property name* knowledge-graph node
Knowledge graph node.
Possible values: Value must match regular expression ^biolink:[A-Z][a-zA-Z]*$
Default value: ``
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
edges objectrequired
Custom class that implements MutableMapping and is hashable
property name* knowledge-graph edge
Knowledge graph edge.
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
sources object[]required
Custom class that implements MutableSet and is hashable
Possible values: [aggregator_knowledge_source
, primary_knowledge_source
, supporting_data_source
]
Types of resources
Default value: ``
Custom class that implements MutableSet and is hashable
Default value: ``
Custom class that implements MutableSet and is hashable
qualifiers object[]nullable
Custom class that implements MutableSet and is hashable
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
results object[]nullable
Results.
node_bindings objectrequired
Custom class that implements MutableMapping and is hashable
property name* HashableSet[NodeBinding]
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
analyses object[]required
Custom class that implements MutableSet and is hashable
edge_bindings objectrequired
Custom class that implements MutableMapping and is hashable
property name* HashableSet[EdgeBinding]
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
auxiliary_graphs objectnullable
Auxiliary Graphs
property name* auxiliary graphnullable
Auxiliary Graph
Default value: ``
Custom class that implements MutableSet and is hashable
attributes object[]required
Custom class that implements MutableSet and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
attributes object[]nullable
Custom class that implements MutableSequence and is hashable
Log level.
workflow object[]
Custom base model for all classes
This provides hash and equality methods.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [annotate
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [annotate_edges
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [annotate_nodes
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [bind
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [complete_results
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [enrich_results
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Possible values: <= 1
Default value: 0.000001
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: Value must match regular expression ^biolink:[a-z][a-z_]*$
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [fill
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_continuous_kedge_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [above
, below
]
'above' or 'below'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_discrete_kedge_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_discrete_knode_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_orphans
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_percentile
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: <= 100
Default value: 95
'above' or 'below'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_std_dev
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
'plus' or 'minus'.
Default value: 1
'above' or 'below'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_kgraph_top_n
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: 50
'top' or 'bottom'.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_results
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [filter_results_top_n
]
An enumeration.
parameters object
Custom base model for all classes
This provides hash and equality methods.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [lookup
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [lookup_and_score
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_compute_jaccard
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_compute_ngd
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_connect_knodes
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [overlay_fisher_exact_test
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [restate
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [score
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results
]
An enumeration.
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results_edge_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [ascending
, descending
]
'ascending' or 'descending'.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results_node_attribute
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [ascending
, descending
]
'ascending' or 'descending'.
Default value: ``
Custom class that implements MutableSequence and is hashable
runner_parameters object
Custom base model for all classes
This provides hash and equality methods.
Default value: ``
Custom class that implements MutableSequence and is hashable
Default value: ``
Custom class that implements MutableSequence and is hashable
Possible values: [sort_results_score
]
An enumeration.
parameters objectrequired
Custom base model for all classes
This provides hash and equality methods.
Possible values: [ascending
, descending
]
'ascending' or 'descending'.
{
"message": {
"query_graph": {
"nodes": {},
"edges": {}
},
"knowledge_graph": {
"nodes": {},
"edges": {}
},
"results": [
{
"node_bindings": {},
"analyses": [
{
"resource_id": "string",
"edge_bindings": {},
"score": 0,
"support_graphs": [
"string"
],
"scoring_method": "string",
"attributes": [
{
"attribute_type_id": "string",
"value_type_id": "string",
"original_attribute_name": "string",
"value_url": "string",
"attribute_source": "string",
"description": "string",
"attributes": [
{
"attribute_type_id": "string",
"value_type_id": "string",
"original_attribute_name": "string",
"value_url": "string",
"attribute_source": "string",
"description": "string",
"attributes": [
{
"attribute_type_id": "string",
"value_type_id": "string",
"original_attribute_name": "string",
"value_url": "string",
"attribute_source": "string",
"description": "string"
}
]
}
]
}
]
}
]
}
],
"auxiliary_graphs": {}
},
"log_level": "ERROR",
"workflow": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"bypass_cache": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
object
{}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- MOD1
- MOD2
- ]
- ]
detail object[]
loc object[]required
string
integer
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X POST 'https://robokop-automat.apps.renci.org/reactome/query' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"message": {
"query_graph": {
"nodes": {},
"edges": {}
},
"knowledge_graph": {
"nodes": {},
"edges": {}
},
"results": [
{
"node_bindings": {},
"analyses": [
{
"resource_id": "string",
"edge_bindings": {},
"score": 0,
"support_graphs": [
"string"
],
"scoring_method": "string",
"attributes": [
{
"attribute_type_id": "string",
"value_type_id": "string",
"original_attribute_name": "string",
"value_url": "string",
"attribute_source": "string",
"description": "string",
"attributes": [
{
"attribute_type_id": "string",
"value_type_id": "string",
"original_attribute_name": "string",
"value_url": "string",
"attribute_source": "string",
"description": "string",
"attributes": [
{
"attribute_type_id": "string",
"value_type_id": "string",
"original_attribute_name": "string",
"value_url": "string",
"attribute_source": "string",
"description": "string"
}
]
}
]
}
]
}
]
}
],
"auxiliary_graphs": {}
},
"log_level": "ERROR",
"workflow": [
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "annotate"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "annotate_edges",
"parameters": {
"attributes": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "annotate_nodes",
"parameters": {
"attributes": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "bind"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "complete_results"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "enrich_results",
"parameters": {
"pvalue_threshold": 0.000001,
"qnode_keys": [
"string"
],
"predicates_to_exclude": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "fill",
"parameters": {
"allowlist": [
"string"
],
"qedge_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_continuous_kedge_attribute",
"parameters": {
"edge_attribute": "string",
"threshold": 0,
"remove_above_or_below": "above",
"qedge_keys": [
"string"
],
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_discrete_kedge_attribute",
"parameters": {
"edge_attribute": "string",
"qedge_keys": [
"string"
],
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_discrete_knode_attribute",
"parameters": {
"node_attribute": "string",
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_orphans"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_percentile",
"parameters": {
"edge_attribute": "string",
"threshold": 95,
"remove_above_or_below": "above",
"qedge_keys": [
"string"
],
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_std_dev",
"parameters": {
"edge_attribute": "string",
"plus_or_minus_std_dev": "plus",
"num_sigma": 1,
"remove_above_or_below": "above",
"qedge_keys": [
"string"
],
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_kgraph_top_n",
"parameters": {
"edge_attribute": "string",
"max_edges": 50,
"remove_top_or_bottom": "top",
"qedge_keys": [
"string"
],
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_results"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "filter_results_top_n",
"parameters": {
"max_results": 0
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "lookup"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "lookup_and_score"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "overlay"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "overlay_compute_jaccard",
"parameters": {
"intermediate_node_key": "string",
"end_node_keys": [
"string"
],
"virtual_relation_label": "string"
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "overlay_compute_ngd",
"parameters": {
"qnode_keys": [
"string"
],
"virtual_relation_label": "string"
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "overlay_connect_knodes"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "overlay_fisher_exact_test",
"parameters": {
"subject_qnode_key": "string",
"object_qnode_key": "string",
"virtual_relation_label": "string",
"rel_edge_key": "string"
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "restate"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "score"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "sort_results"
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "sort_results_edge_attribute",
"parameters": {
"edge_attribute": "string",
"ascending_or_descending": "ascending",
"qedge_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "sort_results_node_attribute",
"parameters": {
"node_attribute": "string",
"ascending_or_descending": "ascending",
"qnode_keys": [
"string"
]
}
},
{
"runner_parameters": {
"allowlist": [
"string"
],
"timeout": 0
},
"id": "sort_results_score",
"parameters": {
"ascending_or_descending": "ascending"
}
}
],
"bypass_cache": true
}'
Click the Send API Request
button above and see the response here!