In [82]:
import requests
import json
URL="http://localhost:1234/v1/swagger.json"
r = requests.get(url = URL)
r
Out[82]:
<Response [200]>
In [83]:
res=json.loads(r.content)
res["paths"].keys()
Out[83]:
[u'/v1/networks/{networkId}/groups/{groupNodeId}/collapse',
u'/v1/networks/{networkId}/groups/{groupNodeId}/expand',
u'/reactomefiviz/v1/pathwayTree',
u'/v1/networks/{networkId}/views/count',
u'/v1/networks/{networkId}/views/first.pdf',
u'/v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}',
u'/v1/networks/{networkId}/tables/{tableType}.csv',
u'/v1/networks/{networkId}/nodes/{nodeId}/neighbors',
u'/reactomefiviz/v1/cluster',
u'/v1/session',
u'/v1/session/name',
u'/v1/collections/{networkId}/tables/{tableType}/columns',
u'/v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass',
u'/diffusion/v1/currentView/diffuse_with_options',
u'/v1/networks/currentNetwork',
u'/v1/networks/{networkId}/views/{viewId}/network/{visualProperty}',
u'/v1/apply/layouts/{algorithmName}/{networkId}',
u'/enrichmentmap/model/{network}',
u'/v1/commands/{namespace}/{command}',
u'/v1/networks/{networkId}',
u'/v1/networks/{networkId}/tables/{tableType}',
u'/v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}/{visualProperty}',
u'/v1/styles/{name}/defaults',
u'/v1/networks/{networkId}/views/{viewId}/{objectType}',
u'/v1/styles/visualproperties/{visualProperty}',
u'/v1/networks/{networkId}/tables/{tableType}.tsv',
u'/v1/networks/{networkId}/views/{viewId}.cx',
u'/v1/networks/{networkId}/views/{viewId}.pdf',
u'/v1/collections',
u'/v1/styles',
u'/v1/networks.json',
u'/enrichmentmap/expressions/{network}',
u'/v1/networks/{networkId}/nodes/{nodeId}/pointer',
u'/cyndex2/v1/networks/{suid}',
u'/reactomefiviz/v1/buildFISubNetwork',
u'/v1/collections/{networkId}/tables',
u'/v1/networks/{networkId}/tables',
u'/v1',
u'/v1/apply/fit/{networkId}',
u'/diffusion/v1/{networkSUID}/views/{networkViewSUID}/diffuse_with_options',
u'/v1/networks/{networkId}/tables/{tableType}/columns',
u'/reactomefiviz/v1/fiVersions',
u'/v1/networks/{networkId}/tables/{tableType}/rows/{primaryKey}',
u'/v1/networks/{networkId}/edges/{edgeId}/isDirected',
u'/',
u'/v1/styles/{name}/dependencies',
u'/v1/networks/count',
u'/v1/networks/{networkId}/views/{viewId}',
u'/v1/apply/styles',
u'/v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}/{visualProperty}/bypass',
u'/v1/version',
u'/v1/apps',
u'/v1/networks/{networkId}/nodes/{nodeId}',
u'/v1/ui/panels',
u'/v1/apply/layouts/copycat/{sourceViewSUID}/{targetViewSUID}',
u'/v1/collections/{networkId}/tables/{tableType}/columns/{columnName}',
u'/v1/collections/count',
u'/v1/commands/{namespace}',
u'/diffusion/v1/{networkSUID}/views/{networkViewSUID}/diffuse',
u'/v1/networks/{networkId}/edges',
u'/v1/networks/{networkId}/edges/selected',
u'/v1/collections/{networkId}/subnetworks',
u'/reactomefiviz/v1/moduleEnrichment/{type}',
u'/v1/networks/{networkId}/views/first.png',
u'/v1/networks/{networkId}/tables/{tableType}/rows/{primaryKey}/{columnName}',
u'/enrichmentmap/expressions/{network}/{node}',
u'/v1/ui',
u'/v1/networks/{networkId}/nodes/selected',
u'/v1/networks/{networkId}/groups/{groupNodeId}',
u'/reactomefiviz/v1/enrichment/{type}',
u'/diffusion/v1/currentView/diffuse',
u'/cyndex2/v1',
u'/v1/networks/{networkId}/edges/count',
u'/v1/apply/edgebundling/{networkId}',
u'/v1/networks/{networkId}/tables/{tableType}/columns/{columnName}',
u'/v1/ui/panels/{panelName}',
u'/v1/styles/{name}.json',
u'/v1/networks/{networkId}/nodes',
u'/v1/apply/styles/{styleName}/{networkId}',
u'/v1/networks/views/currentNetworkView',
u'/v1/networks/{networkId}/groups/count',
u'/v1/styles/count',
u'/v1/networks/{networkId}/edges/{edgeId}',
u'/v1/styles/{name}/mappings/{vpName}',
u'/reactomefiviz/v1/ReactomePathwayEnrichment',
u'/v1/networks/{networkId}/tables/{tableType}/rows',
u'/cyndex2/v1/networks/current',
u'/v1/collections/{networkId}.cx',
u'/v1/styles/visualproperties/{vp}/values',
u'/v1/networks/{networkId}/nodes/count',
u'/v1/styles/{name}',
u'/v1/collections/{networkId}/tables/{tableType}',
u'/v1/tables/count',
u'/v1/networks/{networkId}/nodes/selected/neighbors',
u'/v1/styles/{name}/mappings',
u'/cyndex2/v1/networks',
u'/reactomefiviz/v1/exportPathwayDiagram',
u'/v1/commands',
u'/v1/networks/{networkId}/views/first',
u'/v1/styles/visualproperties',
u'/v1/apply/layouts/{algorithmName}/parameters',
u'/v1/apply/layouts/{algorithmName}',
u'/v1/networks/{networkId}/nodes/{nodeId}/adjEdges',
u'/v1/styles/{name}/mappings/{vp}',
u'/v1/networks',
u'/v1/networks/{networkId}/views',
u'/v1/networks/{networkId}/edges/{edgeId}/{type}',
u'/v1/networks.names',
u'/v1/networks/{networkId}/views/{viewId}/network',
u'/v1/networks/{networkId}/groups',
u'/v1/gc',
u'/v1/networks/{networkId}/views/{viewId}.svg',
u'/v1/apply/layouts',
u'/v1/apply/layouts/{algorithmName}/columntypes',
u'/v1/networks/{networkId}/views/{viewId}.png',
u'/v1/networks/{networkId}/views/first.svg',
u'/v1/ui/lod',
u'/v1/styles/{name}/defaults/{vp}']
In [84]:
res["paths"]['/cyndex2/v1/networks/current']
Out[84]:
{u'get': {u'description': u'Returns summary of collection contains current network.',
u'operationId': u'getCurrentNetworkSummary',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Summary Response'}}},
u'summary': u'Get the summary of current network and collection.',
u'tags': [u'Apps: CyNDEx-2']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Save current network/collection to NDEx',
u'operationId': u'saveCurrentNetworkToNdex',
u'parameters': [{u'description': u'Properties required to save current network to NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexSaveParameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Current network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Save current network/collection to NDEx',
u'tags': [u'Apps: CyNDEx-2']},
u'put': {u'consumes': [u'application/json'],
u'description': u"Update current network's record in NDEx",
u'operationId': u'updateCurrentNetworkInNdex',
u'parameters': [{u'description': u'Properties required to update a network record in NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexSaveParameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Update current Cytoscape network record in NDEx',
u'tags': [u'Apps: CyNDEx-2']}}
In [107]:
res["paths"]
Out[107]:
{u'/': {u'get': {u'description': u'Returns a list of available REST API versions. Currently, v1 is the only available version',
u'operationId': u'getVersions',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'additionalProperties': {u'items': {u'type': u'string'},
u'type': u'array'},
u'type': u'object'}}},
u'summary': u'Get available REST API versions',
u'tags': [u'REST Service']}},
u'/cyndex2/v1': {u'get': {u'description': u'App version and other basic information will be provided.',
u'operationId': u'getAppInfo',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/App Info Response'}}},
u'summary': u'Provide basic information of the CyNDEx-2 app.',
u'tags': [u'Apps: CyNDEx-2']}},
u'/cyndex2/v1/networks': {u'post': {u'consumes': [u'application/json'],
u'description': u'Import network(s) from NDEx.',
u'operationId': u'createNetworkFromNdex',
u'parameters': [{u'description': u'Properties required to import network from NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexImportParams'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Import network from NDEx',
u'tags': [u'Apps: CyNDEx-2']}},
u'/cyndex2/v1/networks/current': {u'get': {u'description': u'Returns summary of collection contains current network.',
u'operationId': u'getCurrentNetworkSummary',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Summary Response'}}},
u'summary': u'Get the summary of current network and collection.',
u'tags': [u'Apps: CyNDEx-2']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Save current network/collection to NDEx',
u'operationId': u'saveCurrentNetworkToNdex',
u'parameters': [{u'description': u'Properties required to save current network to NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexSaveParameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Current network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Save current network/collection to NDEx',
u'tags': [u'Apps: CyNDEx-2']},
u'put': {u'consumes': [u'application/json'],
u'description': u"Update current network's record in NDEx",
u'operationId': u'updateCurrentNetworkInNdex',
u'parameters': [{u'description': u'Properties required to update a network record in NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexSaveParameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Update current Cytoscape network record in NDEx',
u'tags': [u'Apps: CyNDEx-2']}},
u'/cyndex2/v1/networks/{suid}': {u'get': {u'description': u'Returns summary of collection containing the specified network.',
u'operationId': u'getNetworkSummary',
u'parameters': [{u'description': u'Cytoscape Collection/Subnetwork SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'suid',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Summary Response'}}},
u'summary': u'Get the summary of specified network and collection.',
u'tags': [u'Apps: CyNDEx-2']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Save a network/collection to NDEx',
u'operationId': u'saveNetworkToNdex',
u'parameters': [{u'description': u'Cytoscape Collection/Subnetwork SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'suid',
u'required': True,
u'type': u'integer'},
{u'description': u'Properties required to save network to NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexSaveParameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Save network/collection to NDEx',
u'tags': [u'Apps: CyNDEx-2']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Update an NDEx network.',
u'operationId': u'updateNetworkInNdex',
u'parameters': [{u'description': u'Cytoscape Collection/Subnetwork SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'suid',
u'required': True,
u'type': u'integer'},
{u'description': u'Properties required to update a network record in NDEx.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NdexSaveParameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/NDEx Base Response'}}},
u'summary': u'Update an existing NDEx network entry',
u'tags': [u'Apps: CyNDEx-2']}},
u'/diffusion/v1/currentView/diffuse': {u'post': {u'consumes': [u'application/json'],
u'description': u'Diffusion will send the selected network view and its selected nodes to a web-based REST service to calculate network propagation. Results are returned and represented by columns in the node table.\n\nColumns are created for each execution of Diffusion and their names are returned in the response.\n\nThe nodes you would like to use as input should be selected. This will be used to generate the contents of the **diffusion\\_input** column, which represents the query vector and corresponds to h in the diffusion equation.\n\n',
u'operationId': u'diffuse',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Diffusion App Response'}},
u'404': {u'description': u'Network or Network View does not exist',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Execute Diffusion Analysis on Current View',
u'tags': [u'Apps: Diffusion']}},
u'/diffusion/v1/currentView/diffuse_with_options': {u'post': {u'consumes': [u'application/json'],
u'description': u'Diffusion will send the selected network view and its selected nodes to a web-based REST service to calculate network propagation. Results are returned and represented by columns in the node table.\n\nColumns are created for each execution of Diffusion and their names are returned in the response.\n\n',
u'operationId': u'diffuseWithOptions',
u'parameters': [{u'description': u'Diffusion Parameters',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Diffusion Parameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Diffusion App Response'}},
u'404': {u'description': u'Network or Network View does not exist',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Execute Diffusion Analysis on Current View with Options',
u'tags': [u'Apps: Diffusion']}},
u'/diffusion/v1/{networkSUID}/views/{networkViewSUID}/diffuse': {u'post': {u'consumes': [u'application/json'],
u'description': u'Diffusion will send the selected network view and its selected nodes to a web-based REST service to calculate network propagation. Results are returned and represented by columns in the node table.\n\nColumns are created for each execution of Diffusion and their names are returned in the response.\n\nThe nodes you would like to use as input should be selected. This will be used to generate the contents of the **diffusion\\_input** column, which represents the query vector and corresponds to h in the diffusion equation.\n\n',
u'operationId': u'diffuse',
u'parameters': [{u'description': u'Network SUID (see GET /v1/networks)',
u'format': u'int64',
u'in': u'path',
u'name': u'networkSUID',
u'required': True,
u'type': u'integer'},
{u'description': u'Network View SUID (see GET /v1/networks/{networkId}/views)',
u'format': u'int64',
u'in': u'path',
u'name': u'networkViewSUID',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Diffusion App Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Execute Diffusion Analysis on a Specific Network View',
u'tags': [u'Apps: Diffusion']}},
u'/diffusion/v1/{networkSUID}/views/{networkViewSUID}/diffuse_with_options': {u'post': {u'consumes': [u'application/json'],
u'description': u'Diffusion will send the selected network view and its selected nodes to a web-based REST service to calculate network propagation. Results are returned and represented by columns in the node table.\n\nColumns are created for each execution of Diffusion and their names are returned in the response.\n\n',
u'operationId': u'diffuseWithOptions',
u'parameters': [{u'description': u'Network SUID (see GET /v1/networks)',
u'format': u'int64',
u'in': u'path',
u'name': u'networkSUID',
u'required': True,
u'type': u'integer'},
{u'description': u'Network View SUID (see GET /v1/networks/{networkId}/views)',
u'format': u'int64',
u'in': u'path',
u'name': u'networkViewSUID',
u'required': True,
u'type': u'integer'},
{u'description': u'Diffusion Parameters',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Diffusion Parameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Diffusion App Response'}},
u'404': {u'description': u'Network does not exist',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Execute Diffusion Analysis on a Specific Network View with Options',
u'tags': [u'Apps: Diffusion']}},
u'/enrichmentmap/expressions/{network}': {u'get': {u'description': u'',
u'operationId': u'getExpressionDataForNetwork',
u'parameters': [{u'description': u'Network name or SUID',
u'in': u'path',
u'name': u'network',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/ExpressionDataResponse'}}},
u'summary': u'Get enrichment map model data for a given network.',
u'tags': [u'Apps: EnrichmentMap']}},
u'/enrichmentmap/expressions/{network}/{node}': {u'get': {u'description': u'',
u'operationId': u'getExpressionDataForNode',
u'parameters': [{u'description': u'Network name or SUID',
u'in': u'path',
u'name': u'network',
u'required': True,
u'type': u'string'},
{u'description': u'Node SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'node',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/ExpressionDataResponse'}}},
u'summary': u'Get enrichment map model data for a given network.',
u'tags': [u'Apps: EnrichmentMap']}},
u'/enrichmentmap/model/{network}': {u'get': {u'description': u'',
u'operationId': u'getModelData',
u'parameters': [{u'description': u'Network name or SUID',
u'in': u'path',
u'name': u'network',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/EnrichmentMap'}}},
u'summary': u'Get enrichment map model data for a given network.',
u'tags': [u'Apps: EnrichmentMap']}},
u'/reactomefiviz/v1/ReactomePathwayEnrichment': {u'post': {u'consumes': [u'application/json'],
u'description': u'Perform pathway enrichment analysis using Reactome pathways. The pathway tree should be loaded first. Genes should be sent as one gene per line.',
u'operationId': u'performPathwayEnrichmentAnalysis',
u'parameters': [{u'description': u'List of genes delimited by ","',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'type': u'string'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Table Model'}},
u'404': {u'description': u'Cannot perform Reactome pathway enrichment analysis. Check the Cytoscape logging for errors.',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Perform Reactome pathway enrichment analysis',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/buildFISubNetwork': {u'post': {u'consumes': [u'application/json'],
u'description': u'Construct a Reactome functional interaction sub-network for a set of genes passed via HTTP post or in stored in file. The returned value is the id of the constructed network.',
u'operationId': u'buildFISubNetwork',
u'parameters': [{u'description': u'Parameters for Gene Set Analysis',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Gene Set Analysis Parameters'}}],
u'produces': [u'application/json'],
u'responses': {u'404': {u'description': u'Cannot generate a FI sub-network. Check the Cytoscape logging for errors.',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Build a FI subnetwork for a set of genes',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/cluster': {u'get': {u'description': u'Perform spectral partition-based network clustering for the current displayed FI sub-network',
u'operationId': u'clusterFINetwork',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Table Model'}},
u'404': {u'description': u'Cannot perform the FI network cluster. Check the Cytoscape logging for errors.',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Cluster FI Sub-network',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/enrichment/{type}': {u'get': {u'description': u'Perform pathway or GO enrichment analysis for the current displayed network.',
u'operationId': u'performEnrichmentAnalysis',
u'parameters': [{u'description': u'Enrichment type',
u'enum': [u'Pathway', u'BP', u'CC', u'MF'],
u'in': u'path',
u'name': u'type',
u'required': True,
u'type': u'string',
u'x-example': u'Pathway'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Table Model'}},
u'404': {u'description': u'Cannot perform enrichment analysis. Check the Cytoscape logging for errors.',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Perform Enrichment Analysis',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/exportPathwayDiagram': {u'post': {u'description': u'Export pathway diagram from the database in PDF. Diagrams only for pathways labeled with hasDiagram = true in the tree can be exported. The client is required to check if an Event listed in the tree has diagram first before calling this method. If a pathway enrichment analysis has been performed before exporting, entities having hit genes will be highlighted.',
u'operationId': u'exportPathwayDiagram',
u'parameters': [{u'description': u'Option for exporting pathway diagram',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Pathway Digram Option'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/PDF file name for pathway diagram'}}},
u'summary': u'Export pathway diagram in PDF',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/fiVersions': {u'get': {u'description': u'Get the list of Reactome Functional Interaction networks supported by ReactomeFIViz',
u'operationId': u'getFIVersions',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'type': u'object'}, u'type': u'array'}}},
u'summary': u'List versions of FI Networks',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/moduleEnrichment/{type}': {u'get': {u'description': u'Perform pathway or GO enrichment analysis for the network modules in the current displayed network.',
u'operationId': u'performModuleEnrichmentAnalysis',
u'parameters': [{u'description': u'Enrichment type',
u'enum': [u'Pathway', u'BP', u'CC', u'MF'],
u'in': u'path',
u'name': u'type',
u'required': True,
u'type': u'string',
u'x-example': u'Pathway'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Table Model'}},
u'404': {u'description': u'Cannot perform enrichment analysis. Check the Cytoscape logging for errors.',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Perform Enrichment Analysis for Network Modules',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/reactomefiviz/v1/pathwayTree': {u'get': {u'description': u'Load the Reactome pathway hierarchical tree. The root is a virual container and should be skipped.',
u'operationId': u'loadPathwayHierarchy',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/PathwayTreeResponse'}},
u'404': {u'description': u'Cannot load the Reactome tree. Check the Cytoscape logging for errors.',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Load the Reactome pathway tree',
u'tags': [u'Apps: ReactomeFIViz']}},
u'/v1': {u'get': {u'description': u'Returns the status of the server if operational, including version information and available memory and processor resources.',
u'operationId': u'getStatus',
u'parameters': [],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'Server Status',
u'schema': {u'$ref': u'#/definitions/ServerStatusModel'}},
u'500': {u'description': u'CyREST service is unavailable'}},
u'summary': u'Cytoscape RESTful API server status',
u'tags': [u'REST Service', u'Cytoscape System']}},
u'/v1/apply/edgebundling/{networkId}': {u'get': {u'description': u'Apply edge bundling to the Network specified by the `networkId` parameter. Edge bundling is executed with default parameters; at present, optional parameters are not supported.',
u'operationId': u'bundleEdge',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/MessageModel'}}},
u'summary': u'Apply Edge Bundling to a network',
u'tags': [u'Layouts']}},
u'/v1/apply/fit/{networkId}': {u'get': {u'description': u'Fit the first available Network View for the Network specified by the `networkId` parameter to the current window.',
u'operationId': u'fitContent',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/MessageModel'}}},
u'summary': u'Fit network to the window',
u'tags': [u'Network Views']}},
u'/v1/apply/layouts': {u'get': {u'description': u'Returns all available layouts as a list of layout names.\n\n<h3>Important Note</h3>\n\nThis <strong>does not include yFiles layout algorithms</strong>, due to license issues.',
u'operationId': u'layoutList',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'type': u'string'}, u'type': u'array'}}},
u'summary': u'Get all available Layout names',
u'tags': [u'Layouts']}},
u'/v1/apply/layouts/copycat/{sourceViewSUID}/{targetViewSUID}': {u'put': {u'consumes': [u'application/json'],
u'description': u'Copy one network view layout onto another, setting the node location and view scale to match. This makes visually comparing networks simple.\n\n',
u'operationId': u'copyCurrentLayout',
u'parameters': [{u'description': u'Source network view SUID (or "current")',
u'format': u'int64',
u'in': u'path',
u'name': u'sourceViewSUID',
u'required': True,
u'type': u'integer'},
{u'description': u'Target network view SUID (or "current")',
u'format': u'int64',
u'in': u'path',
u'name': u'targetViewSUID',
u'required': True,
u'type': u'integer'},
{u'description': u'Clone the specified network view layout onto another network view',
u'in': u'body',
u'name': u'body',
u'required': False,
u'schema': {u'$ref': u'#/definitions/Copycat Layout Parameters'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Copycat Layout Response'}},
u'404': {u'description': u'Network View does not exist',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Copy network view layout to another view',
u'tags': [u'Layouts']}},
u'/v1/apply/layouts/{algorithmName}': {u'get': {u'description': u'Returns all the details, including names, parameters, and compatible column types for the Layout algorithm specified by the `algorithmName` parameter.',
u'operationId': u'getLayout',
u'parameters': [{u'description': u'Name of the Layout algorithm',
u'in': u'path',
u'name': u'algorithmName',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/LayoutModel'}}},
u'summary': u'Get all details of a Layout algorithm',
u'tags': [u'Layouts']}},
u'/v1/apply/layouts/{algorithmName}/columntypes': {u'get': {u'description': u'Returns a list of all compatible column data types for the Layout algorithm specified by the `algorithmName` parameter.',
u'operationId': u'getCompatibleColumnDataTypes',
u'parameters': [{u'description': u'Name of layout algorithm',
u'in': u'path',
u'name': u'algorithmName',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/LayoutColumnTypesModel'}}},
u'summary': u'Get column data types compatible a Layout algorithm',
u'tags': [u'Layouts']}},
u'/v1/apply/layouts/{algorithmName}/parameters': {u'get': {u'description': u'Returns all editable parameters for the Layout algorithm specified by the `algorithmName` parameter.',
u'operationId': u'getLayoutParameters',
u'parameters': [{u'description': u'Name of the Layout algorithm',
u'in': u'path',
u'name': u'algorithmName',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/LayoutParameterModel'},
u'type': u'array'}}},
u'summary': u'Get Layout parameters',
u'tags': [u'Layouts']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the Layout parameters for the Layout algorithm specified by the `algorithmName` parameter.',
u'operationId': u'updateLayoutParameters',
u'parameters': [{u'description': u'Name of the layout algorithm',
u'in': u'path',
u'name': u'algorithmName',
u'required': True,
u'type': u'string'},
{u'description': u'A list of Layout Parameters with Values.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/LayoutParameterValueModel'},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update Layout parameters for a Layout algorithm',
u'tags': [u'Layouts']}},
u'/v1/apply/layouts/{algorithmName}/{networkId}': {u'get': {u'description': u'Applies the Layout specified by the `algorithmName` parameter to the Network specified by the `networkId` parameter. If the Layout is has an option to use a Column, it can be specified by the `column` parameter.',
u'operationId': u'applyLayout',
u'parameters': [{u'description': u'Name of layout algorithm',
u'in': u'path',
u'name': u'algorithmName',
u'required': True,
u'type': u'string',
u'x-example': u'circular'},
{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Column to be used by the Layout',
u'in': u'query',
u'name': u'column',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/MessageModel'}}},
u'summary': u'Apply a Layout to a Network',
u'tags': [u'Layouts']}},
u'/v1/apply/styles': {u'get': {u'description': u'Returns a list of all Visual Style names. Style names may not be unique.',
u'operationId': u'getStyleNames',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'type': u'string'}, u'type': u'array'}}},
u'summary': u'Get list of all Visual Style names',
u'tags': [u'Visual Styles']}},
u'/v1/apply/styles/{styleName}/{networkId}': {u'get': {u'description': u'Applies the Visual Style specified by the `styleName` parameter to the network specified by the `networkId` parameter.',
u'operationId': u'applyStyle',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'styleName',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/MessageModel'}}},
u'summary': u'Apply Visual Style to a network',
u'tags': [u'Visual Styles']}},
u'/v1/apps': {u'get': {u'description': u'Returns installed Cytoscape Apps that have CyREST accessible Functions or Commands, as a list of App names.',
u'operationId': u'getAppList',
u'parameters': [],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/AppModel'},
u'type': u'array'}}},
u'summary': u'Get installed Automation Accessible Cytoscape Apps',
u'tags': [u'Apps']}},
u'/v1/collections': {u'get': {u'description': u"Returns all Root Networks as an array of SUIDs.\n\nIf a valid Sub-Network SUID is specified in the `subsuid` parameter, the list will contain only the SUID of that Sub-Network's Root Network.",
u'operationId': u'getCollectionsAsSUID',
u'parameters': [{u'description': u'Sub-Network SUID. If this parameter is used, the Root Network of this Sub-Network will be returned.\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'query',
u'name': u'subsuid',
u'required': False,
u'type': u'integer'}],
u'produces': [u'application/json; charset=UTF-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get one or all root networks.',
u'tags': [u'Collections']}},
u'/v1/collections/count': {u'get': {u'description': u'Returns a count of all root networks.',
u'operationId': u'getCollectionCount',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get a count of all root networks.',
u'tags': [u'Collections']}},
u'/v1/collections/{networkId}.cx': {u'get': {u'description': u'Returns a Root Network or Sub-Network in [CX format](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-cx).\n\nIf the `networkId` parameter is a Root Network, this returns that Root Network.\n\nIf the `networkId` parameter is a Sub-Network, this returns the Root Retwork that contains that Sub-Network.',
u'operationId': u'getCollectionAsCx',
u'parameters': [{u'description': u'Root Network or Sub-Network SUID. \n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Get a collection as CX',
u'tags': [u'Collections']}},
u'/v1/collections/{networkId}/subnetworks': {u'get': {u'description': u'Returns a list of SUIDs representing Sub-Networks that belong to the Root Network specified by the `networkId` parameter.',
u'operationId': u'getSubnetworks',
u'parameters': [{u'description': u'Root Network SUID\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get SubNetworks',
u'tags': [u'Collections']}},
u'/v1/collections/{networkId}/tables': {u'get': {u'description': u'Returns a collection of tables belonging to the Root Network specified by the `networkId` parameter. ',
u'operationId': u'getRootTables',
u'parameters': [{u'description': u'Root Network SUID\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Cytoscape Table with Rows'},
u'type': u'array'}}},
u'summary': u'Get Tables in a Root Network',
u'tags': [u'Collections']}},
u'/v1/collections/{networkId}/tables/{tableType}': {u'get': {u'description': u'Returns either the `default` or `shared` table from the Root Network specified by the `networkId` parameter.\n\nRoot network tables, particularly the shared table accessible by specifying the `tableType` parameter as `shared`, are available through Collection operations, and are not normally accessible in other contexts.',
u'operationId': u'getRootTable',
u'parameters': [{u'description': u'Root Network SUID\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The `default` table contains data relevant to a Root Network. The `shared` table contains data shared by all Sub-Networks of a Root Network.',
u'enum': [u'default', u'shared'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Cytoscape Table with Rows'}}},
u'summary': u'Get a specific Table in a Root Network',
u'tags': [u'Collections']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the values in a table. New columns will be created if they do not exist in the target table.\n\nRoot network tables, particularly the shared table accessible by specifying the `tableType` parameter as `shared`, are available through Collection operations, and are not normally accessible in other contexts.',
u'operationId': u'updateTable',
u'parameters': [{u'description': u'Root Network SUID\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The `default` table contains data relevant to a Root Network. The `shared` table contains data shared by all Sub-Networks of a Root Network.',
u'enum': [u'default', u'shared'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'The data with which to update the table.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Table Update Data'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update table values',
u'tags': [u'Collections']}},
u'/v1/collections/{networkId}/tables/{tableType}/columns': {u'get': {u'description': u'Return a list of the columns in the table specified by the `tableType` parameter in the Root Network specified by the `networkId` parameter.\n\nRoot network tables, particularly the shared table accessible by specifying the `tableType` parameter as `shared`, are available through Collection operations, and are not normally accessible in other contexts.',
u'operationId': u'getColumns',
u'parameters': [{u'description': u'Root Network SUID\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The `default` table contains data relevant to a Root Network. The `shared` table contains data shared by all Sub-Networks of a Root Network.',
u'enum': [u'default', u'shared'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Cytoscape Column'},
u'type': u'array'}}},
u'summary': u'Get a list of columns for a Root Network table',
u'tags': [u'Collections']}},
u'/v1/collections/{networkId}/tables/{tableType}/columns/{columnName}': {u'delete': {u'description': u'Deletes the column specified by the `columnName` parameter from the table specified the `tableType` parameter in the Root Network specified by the `networkId` parameter.\n\nRoot network tables, particularly the shared table accessible by specifying the `tableType` parameter as `shared`, are available through Collection operations, and are not normally accessible in other contexts.',
u'operationId': u'deleteColumn',
u'parameters': [{u'description': u'Root Network SUID\n\nCytoscape can contain multiple Root Networks, each with their own Sub-Networks\n```\n\u2500\u2500 Root Network 1\n \u251c\u2500\u2500 Sub-Network A\n \u2514\u2500\u2500 Sub-Network B\n\u2500\u2500 Root Network 2\n \u2514\u2500\u2500 Sub-Network C\n```',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The `default` table contains data relevant to a Root Network. The `shared` table contains data shared by all Sub-Networks of a Root Network.',
u'enum': [u'default', u'shared'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Column Name',
u'in': u'path',
u'name': u'columnName',
u'required': True,
u'type': u'string'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a column',
u'tags': [u'Collections']}},
u'/v1/commands': {u'get': {u'description': u'Method handling HTTP GET requests to enumerate all namespaces. The returned list will be sent to the client as "text/html" media type.\n\nFor a list of all available commands and their documentation, see the [CyREST Command API](http://localhost:1234/v1/swaggerUI/swagger-ui/index.html?url=http%3A%2F%2Flocalhost%3A1234%2Fv1%2Fcommands%2Fswagger.json)',
u'operationId': u'enumerateNamespacesHtml',
u'parameters': [],
u'produces': [u'text/html'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'List all available command namespaces',
u'tags': [u'Commands']}},
u'/v1/commands/{namespace}': {u'get': {u'description': u'Method to enumerate all commands for a given namespace. The returned list will be sent to the client as "text/html" media type.\n\nFor a list of all available commands and their documentation, see the [CyREST Command API](http://localhost:1234/v1/swaggerUI/swagger-ui/index.html?url=http%3A%2F%2Flocalhost%3A1234%2Fv1%2Fcommands%2Fswagger.json)',
u'operationId': u'enumerateHTMLCommands',
u'parameters': [{u'in': u'path',
u'name': u'namespace',
u'required': True,
u'type': u'string'}],
u'produces': [u'text/html'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'List all available commands in a namespace',
u'tags': [u'Commands']}},
u'/v1/commands/{namespace}/{command}': {u'get': {u'description': u'Method to enumerate all arguments for a given namespace and command or execute a namespace and command if query strings are provided.\n\nReturns a list of arguments as text/plain or the results of executing the command.\n\nFor a list of all available commands and their documentation, see the [CyREST Command API](http://localhost:1234/v1/swaggerUI/swagger-ui/index.html?url=http%3A%2F%2Flocalhost%3A1234%2Fv1%2Fcommands%2Fswagger.json)',
u'operationId': u'handleCommand',
u'parameters': [{u'description': u'Command Namespace',
u'in': u'path',
u'name': u'namespace',
u'required': True,
u'type': u'string'},
{u'description': u'Command Name',
u'in': u'path',
u'name': u'command',
u'required': True,
u'type': u'string'}],
u'produces': [u'text/plain'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'Execute a command or list its arguments',
u'tags': [u'Commands']}},
u'/v1/gc': {u'get': {u'description': u"Manually call Java's System.gc() to free up unused memory. This process happens automatically, but may be useful to call explicitly for testing or evaluation purposes.",
u'operationId': u'runGarbageCollection',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'204': {u'description': u'Successful Garbage Collection'}},
u'summary': u'Run Java garbage collection',
u'tags': [u'REST Service', u'Cytoscape System']}},
u'/v1/networks': {u'delete': {u'description': u'Delete all networks in the current session.',
u'operationId': u'deleteAllNetworks',
u'parameters': [],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete all networks in current session',
u'tags': [u'Networks']},
u'get': {u'description': u'Returns a list of all networks as SUIDs.\n\nIf the `column` and `query` parameters are specified, the results will be limited to rows in the network table where the value in the column specified by the `column` parameter matches the value specified by the `query` parameter.',
u'operationId': u'getNetworksAsSUID',
u'parameters': [{u'description': u'The name of the column that will be queried for matches.',
u'in': u'query',
u'name': u'column',
u'required': False,
u'type': u'string'},
{u'description': u'The value to be matched.',
u'in': u'query',
u'name': u'query',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json; charset=UTF-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get SUID list of networks',
u'tags': [u'Networks']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Creates a new network in the current session from a file or URL source.\n\nDepending on the setting of the `format` parameter the source can be in one of several formats:\n\n| Format | Details |\n| -------- | ------- |\n| edgeList | [SIF](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#sif-format) format |\n| cx | [CX](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-cx) format |\n| json | [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format |\nIf the `source` parameter is left unspecified, the message body should contain data in the format specified by the `format` parameter.\n\n\nIf the `source` parameter is specified as "url", the message body should be a list of URLs, formatted as below:\n\n```\n[\n {\n "source_location": "http://somewhere.com/graph.js",\n\t "source_method": "GET",\n\t "ndex_uuid": "12345"\n }\n ...\n]\n```\nThe `source_location` field specifies the URL from which to get data, and the `source_method` field specifies the HTTP method to use. All entries should be in the format specified by the `format` parameter. All the fields in each entry will be copied to columns in the default network table row for the new network.',
u'operationId': u'createNetwork',
u'parameters': [{u'description': u'The name of the network collection to add new networks to. If the collection does not exist, it will be created.',
u'in': u'query',
u'name': u'collection',
u'required': False,
u'type': u'string'},
{u'description': u'Set this to `url` to treat the message body as a list of urls.',
u'enum': [u'url'],
u'in': u'query',
u'name': u'source',
u'required': False,
u'type': u'string'},
{u'description': u'The format of the source data.',
u'enum': [u'edgelist', u'json', u'cx'],
u'in': u'query',
u'name': u'format',
u'required': False,
u'type': u'string'},
{u'description': u'Name of the new network. This is only used if the network name cannot be set directly in source data.',
u'in': u'query',
u'name': u'title',
u'required': False,
u'type': u'string'},
{u'description': u'Source data. This is either the data to be loaded, or a list of URLs from which to load data.',
u'in': u'body',
u'name': u'body',
u'required': False,
u'schema': {u'$ref': u'#/definitions/InputStream'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NetworkSUIDModel'}}},
u'summary': u'Create a new network from a file or URL',
u'tags': [u'Networks']}},
u'/v1/networks.json': {u'get': {u'description': u'Returns a list of all networks as an array of [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format entries.\n\nIf the `column` and `query` parameters are specified, the results will be limited to rows in the network table where the value in the column specified by the `column` parameter matches the value specified by the `query` parameter.',
u'operationId': u'getNetworks',
u'parameters': [{u'description': u'The name of the column that will be queried for matches.',
u'in': u'query',
u'name': u'column',
u'required': False,
u'type': u'string'},
{u'description': u'The value to be matched.',
u'in': u'query',
u'name': u'query',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json; charset=UTF-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u' Get networks in Cytoscape.js JSON format',
u'tags': [u'Networks']}},
u'/v1/networks.names': {u'get': {u'description': u'Returns a list of all networks as names and their corresponding SUIDs.\n\nIf the `column` and `query` parameters are specified, the results will be limited to rows in the network table where the value in the column specified by the `column` parameter matches the value specified by the `query` parameter.',
u'operationId': u'getNetworksNames',
u'parameters': [{u'description': u'The name of the column that will be queried for matches.',
u'in': u'query',
u'name': u'column',
u'required': False,
u'type': u'string'},
{u'description': u'The value to be matched.',
u'in': u'query',
u'name': u'query',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json; charset=UTF-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/SUIDNameModel'},
u'type': u'array'}}},
u'summary': u'Returns a list of network names with corresponding SUIDs',
u'tags': [u'Networks']}},
u'/v1/networks/count': {u'get': {u'description': u'Returns the number of networks in current Cytoscape session.',
u'operationId': u'getNetworkCount',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of networks in current session',
u'tags': [u'Networks']}},
u'/v1/networks/currentNetwork': {u'get': {u'description': u'Returns the current network.',
u'operationId': u'getCurrentNetwork',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NetworkSUIDResponse'}}},
u'summary': u'Get the current network',
u'tags': [u'Networks']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Sets the current network.',
u'operationId': u'setCurrentNetwork',
u'parameters': [{u'description': u'SUID of the Network',
u'in': u'body',
u'name': u'body',
u'required': False,
u'schema': {u'$ref': u'#/definitions/NetworkSUIDModel'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Set the current network',
u'tags': [u'Networks']}},
u'/v1/networks/views/currentNetworkView': {u'get': {u'description': u'Returns the current Network View.',
u'operationId': u'getCurrentNetworkView',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NetworkViewSUIDResponse'}}},
u'summary': u'Get the current Network View',
u'tags': [u'Network Views']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Sets the current Network View.',
u'operationId': u'setCurrentNetworkView',
u'parameters': [{u'description': u'SUID of the Network View',
u'in': u'body',
u'name': u'body',
u'required': False,
u'schema': {u'$ref': u'#/definitions/NetworkViewSUIDModel'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Set the current Network View',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}': {u'delete': {u'description': u'Deletes the network specified by the `networkId` parameter.',
u'operationId': u'deleteNetwork',
u'parameters': [{u'description': u'SUID of the network to delete',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a network',
u'tags': [u'Networks']},
u'get': {u'description': u'Returns the Network specified by the `networkId` parameter with all associated tables in [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format',
u'operationId': u'getNetwork',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'Get a network in Cytoscape.js format',
u'tags': [u'Networks']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Creates new sub-network from current selection, with the name specified by the `title` parameter.\n\nReturns the SUID of the new sub-network.',
u'operationId': u'createNetworkFromSelected',
u'parameters': [{u'description': u'SUID of the network containing the selected nodes and edges',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name for the new sub-network',
u'in': u'query',
u'name': u'title',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NetworkSUIDModel'}}},
u'summary': u'Create a subnetwork from selected nodes and edges',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/edges': {u'delete': {u'description': u'Delete all the edges from the network specified by the `networkId` parameter.',
u'operationId': u'deleteAllEdges',
u'parameters': [{u'description': u'SUID of the network to delete edges from',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete all edges in a network',
u'tags': [u'Networks']},
u'get': {u'description': u'Returns a list of all edges in the network specified by the `networkId` parameter as SUIDs.\n\nIf the `column` and `query` parameters are specified, the results will be limited to rows in the edge table where the value in the column specified by the `column` parameter matches the value specified by the `query` parameter.',
u'operationId': u'getEdges',
u'parameters': [{u'description': u'SUID of the network containing the edges',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The name of the column that will be queried for matches.',
u'in': u'query',
u'name': u'column',
u'required': False,
u'type': u'string'},
{u'description': u'The value to be matched.',
u'in': u'query',
u'name': u'query',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get edges',
u'tags': [u'Networks']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Add new edge(s) to the network. Body should include an array of new node names.\n\nReturns and array of objects with fields itentifying the SUIDs of the new edges along with source and target SUIDs.',
u'operationId': u'createEdge',
u'parameters': [{u'description': u'SUID of the network to add edges to.',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Array of new edges',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/New Edge Parameter'},
u'type': u'array'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Created Edge'},
u'type': u'array'}}},
u'summary': u'Add edge(s) to existing network',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/edges/count': {u'get': {u'description': u'Returns the number of edges in the network specified by the `networkId` parameter.',
u'operationId': u'getEdgeCount',
u'parameters': [{u'description': u'SUID of the network containing the edges',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of edges in the network',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/edges/selected': {u'get': {u'description': u'Gets the selected edges in the network specified by the `networkId` parameter. The results are presented as a list of SUIDs.',
u'operationId': u'getSelectedEdges',
u'parameters': [{u'description': u'SUID of the network containing the edges',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get selected edges',
u'tags': [u'Networks']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Sets as selected the edges specified by the `suids` and `networkId` parameters.\n\nReturns a list of selected SUIDs.',
u'operationId': u'setSelectedEdges',
u'parameters': [{u'description': u'SUID of the network containing the edges',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Array of edge SUIDs to select',
u'in': u'body',
u'name': u'body',
u'required': False,
u'schema': {u'items': {u'format': u'double', u'type': u'number'},
u'type': u'array'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Set selected edges',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/edges/{edgeId}': {u'delete': {u'description': u'Deletes the edge specified by the `edgeId` and `networkId` parameters.',
u'operationId': u'deleteEdge',
u'parameters': [{u'description': u'SUID of the network containing the edge.',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'edgeId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete an edge in the network.',
u'tags': [u'Networks']},
u'get': {u'description': u'Returns an edge with its associated row data.',
u'operationId': u'getEdge',
u'parameters': [{u'description': u'SUID of the network containing the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'edgeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Edge Data'}}},
u'summary': u'Get an edge',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/edges/{edgeId}/isDirected': {u'get': {u'description': u'Returns true if the edge specified by the `edgeId` and `networkId` parameters is directed.',
u'operationId': u'getEdgeDirected',
u'parameters': [{u'description': u'SUID of the network containing the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'edgeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'boolean'}}},
u'summary': u'Get edge directionality',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/edges/{edgeId}/{type}': {u'get': {u'description': u'Returns the SUID of the source or target node of the edge specified by the `edgeId` and `networkId` parameters.\n\nReturn values can be in one of two formats, depending on the value specified in the `type` parameter:\n\n```\n{\n "source": 101\n}\n```\n\n```\n{\n "target": 102\n}\n```\n\n',
u'operationId': u'getEdgeComponent',
u'parameters': [{u'description': u'SUID of the network containing the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the edge',
u'format': u'int64',
u'in': u'path',
u'name': u'edgeId',
u'required': True,
u'type': u'integer'},
{u'description': u'The node type to return',
u'enum': [u'source', u'target'],
u'in': u'path',
u'name': u'type',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'object'}}},
u'summary': u'Get source/target node of an edge',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/groups': {u'delete': {u'description': u'Deletes all groups in the network specified by `networkId` parameter. The nodes and edges that the groups contained will remain present in the network, however the nodes used to identify the Groups will be deleted.',
u'operationId': u'deleteAllGroups',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete all groups in the network',
u'tags': [u'Groups']},
u'get': {u'description': u'Returns a list of all the groups in the network specified by the `networkId` parameter.',
u'operationId': u'getAllGroups',
u'parameters': [{u'description': u'Network SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/A Group of Cytoscape Nodes and Edges'},
u'type': u'array'}}},
u'summary': u'Get all groups in the network',
u'tags': [u'Groups']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Create a new group in the network specified by the parameter `networkId`. The contents are specified the message body.',
u'operationId': u'createGroup',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'New Group name and contents',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NewGroupParameterModel'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/GroupSUIDModel'}}},
u'summary': u'Create a new group',
u'tags': [u'Groups']}},
u'/v1/networks/{networkId}/groups/count': {u'get': {u'description': u'Returns the number of groups in the network',
u'operationId': u'getGroupCount',
u'parameters': [{u'description': u'Network SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of groups in the network',
u'tags': [u'Groups']}},
u'/v1/networks/{networkId}/groups/{groupNodeId}': {u'delete': {u'description': u'Deletes the group specified by the `groupNodeId` and `networkId` parameters. The nodes and edges that the group contained will remain present in the network, however the node used to identify the Group will be deleted.',
u'operationId': u'deleteGroup',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Node representing the Group',
u'format': u'int64',
u'in': u'path',
u'name': u'groupNodeId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a group',
u'tags': [u'Groups']},
u'get': {u'description': u'Returns the group specified by the `groupNodeId` and `networkId` parameters.',
u'operationId': u'getGroup',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Node representing the Group',
u'format': u'int64',
u'in': u'path',
u'name': u'groupNodeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/A Group of Cytoscape Nodes and Edges'}}},
u'summary': u'Get a group by SUID',
u'tags': [u'Groups']}},
u'/v1/networks/{networkId}/groups/{groupNodeId}/collapse': {u'get': {u'description': u'Collapses the group specified by the `groupNodeId` and `networkId` parameters.',
u'operationId': u'collapseGroup',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Node representing the Group',
u'format': u'int64',
u'in': u'path',
u'name': u'groupNodeId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'204': {u'description': u'Group collapsed'},
u'500': {u'description': u'Failed to collapse group'}},
u'summary': u'Collapse group',
u'tags': [u'Groups']}},
u'/v1/networks/{networkId}/groups/{groupNodeId}/expand': {u'get': {u'description': u'Expands the group specified by the `groupNodeId` and `networkId` parameters.',
u'operationId': u'expandGroup',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Node representing the Group',
u'format': u'int64',
u'in': u'path',
u'name': u'groupNodeId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'204': {u'description': u'Group expanded'},
u'500': {u'description': u'Failed to expand group'}},
u'summary': u'Expand group',
u'tags': [u'Groups']}},
u'/v1/networks/{networkId}/nodes': {u'delete': {u'description': u'Delete all the nodes from the network specified by the `networkId` parameter.',
u'operationId': u'deleteAllNodes',
u'parameters': [{u'description': u'SUID of the network to delete nodes from',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete all nodes in a network',
u'tags': [u'Networks']},
u'get': {u'description': u'Returns a list of all nodes in the network specified by the `networkId` parameter as SUIDs.\n\nIf the `column` and `query` parameters are specified, the results will be limited to rows in the node table where the value in the column specified by the `column` parameter matches the value specified by the `query` parameter.',
u'operationId': u'getNodes',
u'parameters': [{u'description': u'SUID of the network containing the nodes',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The name of the column that will be queried for matches.',
u'in': u'query',
u'name': u'column',
u'required': False,
u'type': u'string'},
{u'description': u'The value to be matched.',
u'in': u'query',
u'name': u'query',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get nodes',
u'tags': [u'Networks']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Adds new nodes to the network specified by the `networkId` parameter. The `name` column will be populated by the contents of the message body.',
u'operationId': u'createNode',
u'parameters': [{u'description': u'SUID of the network containing the node.',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Array of new node names',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'type': u'string'}, u'type': u'array'}}],
u'produces': [u'application/json'],
u'responses': {u'201': {u'description': u'',
u'schema': {u'items': {u'$ref': u'#/definitions/SUIDNameModel'},
u'type': u'array'}},
u'412': {u'description': u''}},
u'summary': u'Add node(s) to a network',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/count': {u'get': {u'description': u'Returns the number of nodes in the network specified by the `networkId` parameter.',
u'operationId': u'getNodeCount',
u'parameters': [{u'description': u'SUID of the network containing the nodes',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of nodes in the network',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/selected': {u'get': {u'description': u'Gets the selected nodes in the network specified by the `networkId` parameter. The results are presented as a list of SUIDs.',
u'operationId': u'getSelectedNodes',
u'parameters': [{u'description': u'SUID of the network containing the nodes',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get selected nodes',
u'tags': [u'Networks']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Sets as selected the nodes specified by the `suids` and `networkId` parameters.\n\nReturns a list of selected SUIDs.',
u'operationId': u'setSelectedNodes',
u'parameters': [{u'description': u'SUID of the network containing the nodes',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Array of node SUIDs to select',
u'in': u'body',
u'name': u'body',
u'required': False,
u'schema': {u'items': {u'format': u'double', u'type': u'number'},
u'type': u'array'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Set selected nodes',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/selected/neighbors': {u'get': {u'description': u'Returns the neighbors of the nodes currently selected in the network specified by the `networkId` parameter as a list of SUIDs.\n\nNote that this does not include the nodes in the original selection.',
u'operationId': u'getNeighborsSelected',
u'parameters': [{u'description': u'SUID of the network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get all neighbors of the selected nodes',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/{nodeId}': {u'delete': {u'description': u'Deletes the node specified by the `nodeId` and `networkId` parameters.',
u'operationId': u'deleteNode',
u'parameters': [{u'description': u'SUID of the network containing the node.',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the node',
u'format': u'int64',
u'in': u'path',
u'name': u'nodeId',
u'required': True,
u'type': u'integer'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a node in the network',
u'tags': [u'Networks']},
u'get': {u'description': u'Returns a node with its associated row data.',
u'operationId': u'getNode',
u'parameters': [{u'description': u'SUID of the network containing the node',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the node',
u'format': u'int64',
u'in': u'path',
u'name': u'nodeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Node Data'}}},
u'summary': u'Get a node',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/{nodeId}/adjEdges': {u'get': {u'description': u'Returns a list of connected edges as SUIDs for the node specified by the `nodeId` and `networkId` parameters.',
u'operationId': u'getAdjEdges',
u'parameters': [{u'description': u'SUID of the network containing the node',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the node',
u'format': u'int64',
u'in': u'path',
u'name': u'nodeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get adjacent edges for a node',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/{nodeId}/neighbors': {u'get': {u'description': u'Returns the neighbors of the node specified by the `nodeId` and `networkId` parameters as a list of SUIDs.',
u'operationId': u'getNeighbours',
u'parameters': [{u'description': u'SUID of the network containing the node.',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the node',
u'format': u'int64',
u'in': u'path',
u'name': u'nodeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get neighbors of the node',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/nodes/{nodeId}/pointer': {u'get': {u'description': u'If the node specified by the `nodeId` and `networkId` parameters has an associated nested network, returns the SUID of the nested network.',
u'operationId': u'getNetworkPointer',
u'parameters': [{u'description': u'SUID of the network containing the node',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the node',
u'format': u'int64',
u'in': u'path',
u'name': u'nodeId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/NetworkSUIDModel'}}},
u'summary': u'Get network pointer (nested network SUID)',
u'tags': [u'Networks']}},
u'/v1/networks/{networkId}/tables': {u'get': {u'description': u'Returns every table in the network specified by the `networkId` parameter.',
u'operationId': u'getTables',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Cytoscape Table with Rows'},
u'type': u'array'}}},
u'summary': u'Get all Tables assigned to the Network',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}': {u'get': {u'description': u"Returns the table specified by the `networkId` and 'tableType' parameters.",
u'operationId': u'getTable',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Cytoscape Table with Rows'}}},
u'summary': u'Get a default table',
u'tags': [u'Tables']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the table specified by the `tableType` and `networkId` parameters. New columns will be created if they do not exist in the target table.\n\nCurrent limitations:\n* Numbers are handled as Double\n* List column is not supported in this version\n',
u'operationId': u'updateTable',
u'parameters': [{u'description': u'SUID containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of table',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'enum': [u'local'],
u'in': u'query',
u'name': u'class',
u'required': False,
u'type': u'string'},
{u'description': u'The data with which to update the table.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Table Update Data'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update default node/edge/network data table',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}.csv': {u'get': {u'description': u'Returns a CSV representation of the table specified by the `networkId` and `tableType` parameters. All column names are included in the first row.',
u'operationId': u'getTableAsCsv',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'produces': [u'text/plain'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'Get a table as CSV',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}.tsv': {u'get': {u'description': u'Returns a TSV (tab delimited text) representation of the table specified by the `networkId` and `tableType` parameters. All column names are included in the first row.',
u'operationId': u'getTableAsTsv',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'produces': [u'text/plain'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'Get a table as TSV (tab delimited text)',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}/columns': {u'get': {u'description': u'Returns all the columns in the table specified by the `networkId` and `tableType` parameters.',
u'operationId': u'getColumnNames',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table Type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Cytoscape Column'},
u'type': u'array'}}},
u'summary': u'Get all columns in a table',
u'tags': [u'Tables']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Creates a new, empty column in the table specified by the `tableType` parameter, in the network specified by the `networkId` parameter.\n\nThis resource can also accept an array of new columns to create multiple columns.',
u'operationId': u'createColumn',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table Type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'New Column Info',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/NewColumnParameterModel'}}],
u'responses': {u'201': {u'description': u'Column(s) createed'},
u'412': {u'description': u'Could not process column JSON'}},
u'summary': u'Create new column(s) in the table',
u'tags': [u'Tables']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Renames an existing column in the table specified by the `tableType` and `networkId` parameters.',
u'operationId': u'updateColumnName',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table Type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Old and new column name',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/RenameModel'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update a column name',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}/columns/{columnName}': {u'delete': {u'description': u'Deletes the column specified by the `columnName` parameter from the table speficied by the `tableType` and `networkId` parameters.',
u'operationId': u'deleteColumn',
u'parameters': [{u'description': u'SUID of the network containing the table from which to delete the column',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table Type from which to delete the column',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the column to delete',
u'in': u'path',
u'name': u'columnName',
u'required': True,
u'type': u'string'}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a column in a table',
u'tags': [u'Tables']},
u'get': {u'description': u'Returns all the values for the column specified by the `columnType` parameter, in the table specified by the `networkId` and `tableType` parameters.',
u'operationId': u'getColumnValues',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Table',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the Column',
u'in': u'path',
u'name': u'columnName',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Cytoscape Column Values'}}},
u'summary': u'Get all values in a column',
u'tags': [u'Tables']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Sets the values for cells in the table specified by the `tableType` and `networkId` parameters.\n\nIf the \'default` parameter is not specified, the message body should consist of key-value pairs with which to set values.\n\nIf the `default` parameter is specified, its value will be used for every cell in the column. This is useful to set columns like "selected."',
u'operationId': u'updateColumnValues',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'The type of table',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the column in which to set values',
u'in': u'path',
u'name': u'columnName',
u'required': True,
u'type': u'string'},
{u'description': u'Default Value. If this value is provided, all cells will be set to this.',
u'in': u'query',
u'name': u'default',
u'required': False,
u'type': u'string'},
{u'description': u'Array of SUID Keyed values',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/SUIDKeyValueModel'},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update values in a column',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}/rows': {u'get': {u'description': u'Returns all rows from the table specified by `networkId` and `tableType` parameters. Returns a JSON representation of an array of rows.\n\n```\n[\n {\n "SUID": 101,\n "gene_name": "brca1",\n "exp": 0.1\n },\n {\n "SUID": 102,\n "gene_name": "brca2",\n "exp": 0.2\n }\n]\n```',
u'operationId': u'getRows',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table Type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Row Data'},
u'type': u'array'}}},
u'summary': u'Get all rows in a table',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}/rows/{primaryKey}': {u'get': {u'description': u'Gets a row matching the value specified by the `primaryKey` parameter from the table specified by the `tableType` and `networkId` parameters.\n\nData is represented by column names and their values.\n\n```json\n{\n "name": "Hodor 1",\n "value": 0.11,\n "matched": false\n ...\n}\n```',
u'operationId': u'getRow',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Primary key of the row Object, normally an SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'primaryKey',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Row Data'}}},
u'summary': u'Get a row in the table',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/tables/{tableType}/rows/{primaryKey}/{columnName}': {u'get': {u'description': u'Return the value of a cell specified by the `primaryKey` and `columnName` parameters in the table specified by the `tableType` and `networkId` parameters.\n\nReturns a JSON representation of a String, Boolean, Number, or List.',
u'operationId': u'getCell',
u'parameters': [{u'description': u'SUID of the network containing the table',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Table type',
u'enum': [u'defaultnode', u'defaultedge', u'defaultnetwork'],
u'in': u'path',
u'name': u'tableType',
u'required': True,
u'type': u'string'},
{u'description': u'Primary key of the row Object, normally an SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'primaryKey',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Column',
u'in': u'path',
u'name': u'columnName',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'object'}}},
u'summary': u'Get a value from a cell',
u'tags': [u'Tables']}},
u'/v1/networks/{networkId}/views': {u'delete': {u'description': u'Deletes all Network Views available in the Network specified by the `networkId` parameter. Cytoscape can have multiple views per network model, but this feature is not exposed in the Cytoscape GUI. GUI access is limited to the first available view only.\n\n',
u'operationId': u'deleteAllNetworkViews',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete all Network Views',
u'tags': [u'Network Views']},
u'get': {u'description': u'Returns an array of all network views belonging to the network specified by the `networkId` paramter. The response is a list of Network SUIDs.',
u'operationId': u'getAllNetworkViews',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'An array of Network View SUIDs',
u'schema': {u'items': {u'format': u'int64', u'type': u'integer'},
u'type': u'array'}}},
u'summary': u'Get all Network Views',
u'tags': [u'Network Views']},
u'post': {u'description': u'Creates a new Network View for the Network specified by the `networkId` parameter.',
u'operationId': u'createNetworkView',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'201': {u'description': u'Network View SUID',
u'schema': {u'$ref': u'#/definitions/NetworkViewSUIDModel'}}},
u'summary': u'Create a new Network View',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/count': {u'get': {u'description': u'Returns a count of the Network Views available for the Network specified by the `networkId` parameter.\n\nCytoscape can have multiple views per network model, but this feature is not exposed in the Cytoscape GUI. GUI access is limited to the first available view only.',
u'operationId': u'getNetworkViewCount',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of views for the given network model',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/first': {u'delete': {u'description': u'Deletes the first available Network View for the Network specified by the `networkId` parameter. Cytoscape can have multiple views per network model, but this feature is not exposed in the Cytoscape GUI. GUI access is limited to the first available view only.',
u'operationId': u'deleteFirstNetworkView',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete the first available view',
u'tags': [u'Network Views']},
u'get': {u'description': u'This returns the first view of the network. Cytoscape can have multiple views per network model, but this feature is not exposed in the Cytoscape GUI. GUI access is limited to the first available view only.\n\nIf the `file` parameter is left unspecified, the response will contain data in [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format.\n\nIf the `file` parameter is specified, the Network View will be written to a file, and the response will contain the location of the file in the following format:\n\n```\n\n{\n "file": "/media/HD1/myFiles/networkView.sif"\n}\n```\n\nThe format of the output file is defined by the extension of the `file` parameter.',
u'operationId': u'getFirstNetworkView',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'A path to a file relative to the current directory. The format of the file written is defined by the file extension.\n\n| Extension | Details |\n| ----------- | -----------|\n| .cys | Cytoscape Style format |\n| .xml/.xgmml | [XGMML](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html?highlight=xgmml#xgmml-format) format |\n| .nnf | [NNF](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#nnf) format |\n| .sif | [SIF](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#sif-format) format |\n| .cyjs | [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format |\n',
u'in': u'query',
u'name': u'file',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Get the first Network View (as JSON or a file)',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/first.pdf': {u'get': {u'description': u'Returns a PDF of the first available Network View for the Network specified by the `networkId` parameter.\n\nDefault size is 600 px',
u'operationId': u'getFirstImageAsPdf',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'default': 600,
u'description': u'Height of the image. Width is set automatically',
u'format': u'int32',
u'in': u'query',
u'name': u'h',
u'required': False,
u'type': u'integer'}],
u'produces': [u'image/pdf'],
u'responses': {u'200': {u'description': u'PDF image stream.'}},
u'summary': u'Get PDF image of the first available network view',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/first.png': {u'get': {u'description': u'Returns a PNG image of the first available Network View for the Network specified by the `networkId` parameter.\n\nDefault size is 600 px',
u'operationId': u'getFirstImageAsPng',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'default': 600,
u'description': u'Height of the image. Width is set automatically',
u'format': u'int32',
u'in': u'query',
u'name': u'h',
u'required': False,
u'type': u'integer'}],
u'produces': [u'image/png'],
u'responses': {u'200': {u'description': u'PNG image stream.'}},
u'summary': u'Get PNG image of the first available network view',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/first.svg': {u'get': {u'description': u'Returns an SVG image of the first available Network View for the Network specified by the `networkId` parameter.\n\nDefault size is 600 px',
u'operationId': u'getFirstImageAsSvg',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'default': 600,
u'description': u'Height of the image. Width is set automatically',
u'format': u'int32',
u'in': u'query',
u'name': u'h',
u'required': False,
u'type': u'integer'}],
u'produces': [u'image/svg+xml'],
u'responses': {u'200': {u'description': u'SVG image stream.'}},
u'summary': u'Get SVG image of the first available network view',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}': {u'get': {u'description': u'Gets the Network View specified by the `viewId` and `networkId` parameters.\n\nIf the `file` parameter is left unspecified, the response will contain data in [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format.\n\nIf the `file` parameter is specified, the Network View will be written to a file, and the response will contain the location of the file in the following format:\n\n```\n\n{\n "file": "/media/HD1/myFiles/networkView.sif"\n}\n```\n\nThe format of the output file is defined by the extension of the `file` parameter.',
u'operationId': u'getNetworkView',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'A path to a file relative to the current directory. The format of the file written is defined by the file extension.\n\n| Extension | Details |\n| ----------- | -----------|\n| .cys | Cytoscape Style format |\n| .xml/.xgmml | [XGMML](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html?highlight=xgmml#xgmml-format) format |\n| .nnf | [NNF](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#nnf) format |\n| .sif | [SIF](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#sif-format) format |\n| .cyjs | [Cytoscape.js](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-js-json) format |\n',
u'in': u'query',
u'name': u'file',
u'required': False,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Get a Network View (as JSON or a file)',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}.cx': {u'get': {u'description': u'Returns the Network View specified by the `viewId` and `networkId` parameters in [CX format](http://manual.cytoscape.org/en/stable/Supported_Network_File_Formats.html#cytoscape-cx)',
u'operationId': u'getNetworkViewAsCx',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Get a Network View in CX format',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}.pdf': {u'get': {u'description': u'Returns a PDF of the Network View specified by the `viewId` and `networkId` parameters.\n\nDefault size is 500 px.',
u'operationId': u'getImageAsPdf',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'image/pdf'],
u'responses': {u'200': {u'description': u'PDF image stream.'}},
u'summary': u'Get PDF image of a network view',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}.png': {u'get': {u'description': u'Returns a PNG image of the Network View specified by the `viewId` and `networkId` parameters.\n\nDefault size is 600 px.',
u'operationId': u'getImageAsPng',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'default': 600,
u'description': u'Height of the image. Width is set automatically',
u'format': u'int32',
u'in': u'query',
u'name': u'h',
u'required': False,
u'type': u'integer'}],
u'produces': [u'image/png'],
u'responses': {u'200': {u'description': u'PNG image stream.'}},
u'summary': u'Get PNG image of a network view',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}.svg': {u'get': {u'description': u'Returns an SVG image of the Network View specified by the `viewId` and `networkId` parameters.\n\nDefault size is 600 px.',
u'operationId': u'getImageAsSvg',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'default': 600,
u'description': u'Height of the image. Width is set automatically',
u'format': u'int32',
u'in': u'query',
u'name': u'h',
u'required': False,
u'type': u'integer'}],
u'produces': [u'image/svg+xml'],
u'responses': {u'200': {u'description': u'SVG image stream.'}},
u'summary': u'Get SVG image of a network view',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/network': {u'get': {u'description': u'Returns a list of the Visual Properties for the Network View specified by the `viewId` and `networkId` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getNetworkVisualProps',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Value'},
u'type': u'array'}}},
u'summary': u'Get the Visual Properties for a Network View',
u'tags': [u'Network Views']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the Visual Properties in the Network View specified by the `viewId` and `networkId` parameters.\n\nExample Visual Properties:\n```\n{\n "visualProperty": "NETWORK_BACKGROUND_PAINT",\n "value": "#000000"\n}```\n```\n{\n "visualProperty": "NETWORK_CENTER_X_LOCATION",\n "value": 250\n}```\n\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\nNote that this sets the Visual Properties temporarily unless the `bypass` parameter is set to `true`. If the `bypass` parameter is set to `true`, the Visual Style will be overridden by these Visual Property values. If the `bypass` parameter is not used or is set to `false`, any Visual Properties set will return to those defined in the Visual Style if the Network View is updated.\n',
u'operationId': u'updateNetworkView',
u'parameters': [{u'description': u'Network SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Network View SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'default': False,
u'description': u'Bypass the Visual Style with these properties',
u'in': u'query',
u'name': u'bypass',
u'required': False,
u'type': u'boolean'},
{u'description': u'A list of Visual Properties and their values.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Value'},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update the Visual Properties for a Network View',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/network/{visualProperty}': {u'get': {u'description': u'Gets the Network Visual Property specificed by the `visualProperty`, `viewId`, and `networkId` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getNetworkVisualProp',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'Get a network Visual Property',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass': {u'delete': {u'description': u'Deletes the bypass Visual Property specificed by the `visualProperty`, `viewId`, and `networkId` parameters. When this is done, the Visual Property will be defined by the Visual Style\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'deleteNetworkVisualProp',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Deletes the Visual Property the Network Visual Style is bypassed with',
u'tags': [u'Network Views']},
u'get': {u'description': u'Gets the bypass Visual Property specified by the `visualProperty`, `viewId`, and `networkId` parameters. The response is the Visual Property that is used in place of the definition provided by the Visual Style.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getNetworkVisualPropBypass',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/SingleVisualPropertyResponse'}}},
u'summary': u'Get the Visual Property the Network Visual Style is bypassed with',
u'tags': [u'Network Views']},
u'put': {u'description': u'Bypasses the Visual Style of the Network with the Visual Property specificed by the `visualProperty`, `viewId`, and `networkId` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'putNetworkVisualPropBypass',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'},
{u'description': u'A Visual Property and its value.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Visual Property Value'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Bypass the Network Visual Style with a set Visual Property',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/{objectType}': {u'get': {u'description': u'Returns a list of all Visual Property values for the Visual Property specified by the `visualProperty` and `objectType` parameters, in the Network View specified by the `viewId` and `networkId` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getViews',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges', u'network'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the Visual Property',
u'in': u'query',
u'name': u'visualProperty',
u'required': False,
u'type': u'string',
u'x-example': u'NODE_SHAPE'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/ObjectVisualPropertyValueModel'},
u'type': u'array'}}},
u'summary': u'Get all set values for a specific Visual Property',
u'tags': [u'Network Views']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates multiple node or edge Visual Properties as defined by the `objectType` parameter, in the Network View specified by the `viewId` and `networkId` parameters.\n\nExamples of Visual Properties:\n\n```\n{\n "visualProperty": "NODE_BORDER_WIDTH",\n "value": 2\n}\n```\n```\n{\n "visualProperty": "NODE_BORDER_PAINT",\n "value": "#CCCCCC"\n}\n```\n\n```\n{\n "visualProperty": "EDGE_TRANSPARENCY",\n "value": 170\n}```\n```\n{\n "visualProperty": "EDGE_PAINT",\n "value": "#808080"\n }```\n\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\nNote that this sets the Visual Properties temporarily unless the `bypass` parameter is set to `true`. If the `bypass` parameter is set to `true`, the Visual Style will be overridden by these Visual Property values. If the `bypass` parameter is not used or is set to `false`, any Visual Properties set will return to those defined in the Visual Style if the Network View is updated.\n',
u'operationId': u'updateViews',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'default': False,
u'description': u'Bypass the Visual Style with these Visual Properties',
u'in': u'query',
u'name': u'bypass',
u'required': False,
u'type': u'boolean'},
{u'description': u'A list of Objects with Visual Properties.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/ObjectVisualPropertyValueModel'},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update multiple node/edge Visual Properties at once',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}': {u'get': {u'description': u'Gets a list of Visual Properties for the Object specified by the `objectId` and `objectType` parameters in the Network View specified by the `viewId` and `networkId` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\n',
u'operationId': u'getView',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of the Object',
u'format': u'int64',
u'in': u'path',
u'name': u'objectId',
u'required': True,
u'type': u'integer'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Value'},
u'type': u'array'}}},
u'summary': u'Get the Visual Properties for a Node or Edge Object',
u'tags': [u'Network Views']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the Visual Properties in the object specified by the `objectId` and `objectType` parameters in the Network View specified by the `viewId` and `networkId` parameters.\n\nExamples of Visual Properties:\n\n```\n{\n "visualProperty": "NODE_BORDER_WIDTH",\n "value": 2\n}\n```\n\n```\n{\n "visualProperty": "EDGE_TRANSPARENCY",\n "value": 170\n}```\n\n```\n{\n "visualProperty": "NETWORK_BACKGROUND_PAINT",\n "value": "#000000"\n}```\n\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\nNote that this sets the Visual Properties temporarily unless the `bypass` parameter is set to `true`. If the `bypass` parameter is set to `true`, the Visual Style will be overridden by these Visual Property values. If the `bypass` parameter is not used or is set to `false`, any Visual Properties set will return to those defined in the Visual Style if the Network View is updated.\n',
u'operationId': u'updateView',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges', u'network'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of the Object',
u'format': u'int64',
u'in': u'path',
u'name': u'objectId',
u'required': True,
u'type': u'integer'},
{u'default': True,
u'description': u'Bypass the Visual Style with these Visual Properties',
u'in': u'query',
u'name': u'bypass',
u'required': False,
u'type': u'boolean'},
{u'description': u'A list of Visual Properties and their values.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Value'},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update the Visual Properties of an Object',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}/{visualProperty}': {u'get': {u'description': u'Gets the Visual Property specificed by the `visualProperty` parameter for the node or edge specified by the `objectId` parameter in the Network View specified by the `viewId` and `networkId` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\n',
u'operationId': u'getSingleVisualPropertyValue',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of the Object',
u'format': u'int64',
u'in': u'path',
u'name': u'objectId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string',
u'x-example': u'NODE_SHAPE'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Visual Property Value'}}},
u'summary': u'Get a Visual Property for an Object',
u'tags': [u'Network Views']}},
u'/v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}/{visualProperty}/bypass': {u'delete': {u'description': u'Deletes the bypass Visual Property specified by the `visualProperty` parameter from the object specified by the `objectId` and `objectType` parameters in the Network View Specified by the `viewId` and `networkId` parameters. When this is done, the Visual Property will be defined by the Visual Style\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\n',
u'operationId': u'deleteSingleVisualPropertyValueBypass',
u'parameters': [{u'description': u'SUID of the Network',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'SUID of the Network View',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of Object',
u'format': u'int64',
u'in': u'path',
u'name': u'objectId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CIResponse'}}},
u'summary': u'Delete the Visual Property a Visual Style is bypassed with',
u'tags': [u'Network Views']},
u'get': {u'description': u'Gets the bypass Visual Property specified by the `visualProperty` parameter from the object specified by the `objectId` and `objectType` parameters in the Network View Specified by the `viewId` and `networkId` parameters. The response is the Visual Property that is used in place of the definition provided by the Visual Style.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\n',
u'operationId': u'getSingleVisualPropertyValueBypass',
u'parameters': [{u'description': u'Network SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Network View SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of the Object',
u'format': u'int64',
u'in': u'path',
u'name': u'objectId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/SingleVisualPropertyResponse'}}},
u'summary': u'Get the Visual Properties a Visual Style is bypassed with',
u'tags': [u'Network Views']},
u'put': {u'description': u'Bypasses the Visual Style of the object specified by the `objectId` and `objectType` parameters, in the Network View specified by the `viewId` and `networkId` parameters. The Visual Property included in the message body will be used instead of the definition provided by the Visual Style.\n\nExamples of Visual Properties:\n\n```\n{\n "visualProperty": "NODE_BORDER_WIDTH",\n "value": 2\n}\n```\n\n```\n{\n "visualProperty": "EDGE_TRANSPARENCY",\n "value": 170\n}```\n\n```\n{\n "visualProperty": "NETWORK_BACKGROUND_PAINT",\n "value": "#000000"\n}```\n\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'putSingleVisualPropertyValueBypass',
u'parameters': [{u'description': u'Network SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'networkId',
u'required': True,
u'type': u'integer'},
{u'description': u'Network View SUID',
u'format': u'int64',
u'in': u'path',
u'name': u'viewId',
u'required': True,
u'type': u'integer'},
{u'description': u'Type of Object',
u'enum': [u'nodes', u'edges'],
u'in': u'path',
u'name': u'objectType',
u'required': True,
u'type': u'string'},
{u'description': u'SUID of the Object',
u'format': u'int64',
u'in': u'path',
u'name': u'objectId',
u'required': True,
u'type': u'integer'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string'},
{u'description': u'A Visual Property and its value.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Visual Property Value'}}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Bypass a Visual Style with a set Visual Property',
u'tags': [u'Network Views']}},
u'/v1/session': {u'delete': {u'description': u'This deletes the current session and initializes a new one. A message is returned to indicate the success of the deletion.',
u'operationId': u'deleteSession',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/MessageModel'}}},
u'summary': u'Delete current Session',
u'tags': [u'Session']},
u'get': {u'description': u'Loads a session from a local file and returns the session file name',
u'operationId': u'getSessionFromFile',
u'parameters': [{u'description': u'Session file location as an absolute path',
u'in': u'query',
u'name': u'file',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/FileModel'}}},
u'summary': u'Load a Session from a local file',
u'tags': [u'Session']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Saves the current session to a file. If successful, the session file location will be returned.',
u'operationId': u'createSessionFile',
u'parameters': [{u'description': u'Session file location as an absolute path',
u'in': u'query',
u'name': u'file',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/FileModel'}}},
u'summary': u'Save current Session to a file',
u'tags': [u'Session']}},
u'/v1/session/name': {u'get': {u'description': u'Returns the file name for the current Cytoscape session.',
u'operationId': u'getSessionName',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Session File name'}}},
u'summary': u'Get current session file name',
u'tags': [u'Session']}},
u'/v1/styles': {u'delete': {u'description': u'Deletes all vision styles except for default style',
u'operationId': u'deleteAllStyles',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete all Visual Styles',
u'tags': [u'Visual Styles']},
u'get': {u'description': u'Returns a list of all the Visual Style names in the current session.',
u'operationId': u'getStyleNames',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'type': u'string'}, u'type': u'array'}}},
u'summary': u'Get list of Visual Style names',
u'tags': [u'Visual Styles']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Creates a new Visual Style using the message body.\n\nReturns the title of the new Visual Style. If the title of the Visual Style already existed in the session, a new one will be automatically generated and returned.',
u'operationId': u'createStyle',
u'parameters': [{u'description': u'The details of the new Visual Style to be created.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/VisualStyleModel'}}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Title Model'}}},
u'summary': u'Create a new Visual Style from JSON.',
u'tags': [u'Visual Styles']}},
u'/v1/styles/count': {u'get': {u'description': u'Returns the number of Visual Styles available in the current session',
u'operationId': u'getStyleCount',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of Visual Styles',
u'tags': [u'Visual Styles']}},
u'/v1/styles/visualproperties': {u'get': {u'description': u'Get all available Visual Properties.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getVisualProperties',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/VisualPropertyModel'},
u'type': u'array'}}},
u'summary': u'Get all available Visual Properties',
u'tags': [u'Visual Styles']}},
u'/v1/styles/visualproperties/{visualProperty}': {u'get': {u'description': u'Return the Visual Property specified by the `visualProperty` parameter.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getSingleVisualProperty',
u'parameters': [{u'description': u'ID of the Visual Property',
u'in': u'path',
u'name': u'visualProperty',
u'required': True,
u'type': u'string',
u'x-example': u'NODE_SHAPE'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/VisualPropertyModel'}}},
u'summary': u'Get a Visual Property',
u'tags': [u'Visual Styles']}},
u'/v1/styles/visualproperties/{vp}/values': {u'get': {u'description': u'Returns a list of all available values for the Visual Property specified by the `vp` parameter.\n\nThis method is only for Visual Properties with a Discrete Range, such as NODE_SHAPE or EDGE_LINE_TYPE.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\n',
u'operationId': u'getRangeValues',
u'parameters': [{u'description': u'ID of the Visual Property',
u'in': u'path',
u'name': u'vp',
u'required': True,
u'type': u'string',
u'x-example': u'NODE_SHAPE'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/VisualPropertyValuesModel'}}},
u'summary': u'Get all available values for a Visual Property',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}': {u'delete': {u'description': u'Deletes the Visual Style specified by the `name` parameter.',
u'operationId': u'deleteStyle',
u'parameters': [{u'description': u'Visual Style Name',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a Visual Style',
u'tags': [u'Visual Styles']},
u'get': {u'description': u'Returns the Visual Style specified by the `name` parameter.',
u'operationId': u'getStyleFull',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/VisualStyleModel'}}},
u'summary': u'Get a Visual Style with full details',
u'tags': [u'Visual Styles']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the name of the Visual Style specified by the `name` parameter.',
u'operationId': u'updateStyleName',
u'parameters': [{u'description': u'Original name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'A new name for the Visual Style.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'$ref': u'#/definitions/Title Model'}}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update name of a Visual Style',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}.json': {u'get': {u'description': u'Visual Style in [Cytoscape.js CSS](http://js.cytoscape.org/#style) format.',
u'operationId': u'getStyle',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'type': u'string'}}},
u'summary': u'Get a Visual Style in Cytoscape.js CSS format.',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}/defaults': {u'get': {u'description': u'Returns a list of all the default values for the Visual Style specified by the `name` parameter.',
u'operationId': u'getDefaults',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/VisualStyleDefaultsModel'}}},
u'summary': u'Get all default values for the Visual Style',
u'tags': [u'Visual Styles']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the default values for the Visual Properties in the Visual Style specified by the `name` parameter.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'updateDefaults',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'A list of Visual Property values to update.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Value'},
u'type': u'array'}}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update the default values for Visual Properties',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}/defaults/{vp}': {u'get': {u'description': u'Returns the default value for the Visual Property specified by the `name` and `vp` parameters.\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)\n\n',
u'operationId': u'getDefaultValue',
u'parameters': [{u'description': u'Name of the Visual Style containing the Visual Property',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the Visual Property',
u'in': u'path',
u'name': u'vp',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Visual Property Value'}}},
u'summary': u'Get a default value for the Visual Property',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}/dependencies': {u'get': {u'description': u'Returns the status of all the Visual Property Dependencies.',
u'operationId': u'getAllDependencies',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Dependency'},
u'type': u'array'}}},
u'summary': u'Get all Visual Property Dependency statuses',
u'tags': [u'Visual Styles']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Sets the value of Visual Property dependencies to the values in the message body.',
u'operationId': u'updateDependencies',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'A list of dependencies.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/Visual Property Dependency'},
u'type': u'array'}}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Set Visual Property Dependencies',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}/mappings': {u'get': {u'description': u'Returns a list of all Visual Mappings used in the Visual Style specified by the `name` parameter.\n\nThe types of mapping available in Cytoscape are explained in depth [here](http://manual.cytoscape.org/en/stable/Styles.html#how-mappings-work). An example of the data format for each is included below. For additional details, such as what Visual Properties supported by each Mapping, click on the relevant JavaDoc API link.\n\n#### Discrete Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/DiscreteMapping.html)\n```\n{ "mappingType": "discrete",\n "mappingColumn": "interaction",\n\t "mappingColumnType": "String",\n\t "visualProperty": "EDGE_WIDTH", \n\t "map": [\n { "key" : "pd",\n "value" : "20"\n },\n { "key" : "pp",\n "value" : "1.5"\n }\n ]\n}```\n#### Continuous Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/ContinuousMapping.html)\n```\n{ "mappingType": "continuous",\n "mappingColumn": "Degree",\n "mappingColumnType": "Integer",\n "visualProperty": "NODE_SIZE",\n "points": [\n { "value" : 1,\n "lesser" : "20",\n "equal" : "20",\n "greater" : "20"\n },\n\t { "value" : 20,\n "lesser" : "120",\n "equal" : "120",\n "greater" : "220" }\n ]\n}```\n#### Passthrough Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/PassthroughMapping.html)\n```\n{ "mappingType": "passthrough",\n "mappingColumn": "name",\n "mappingColumnType": "String",\n "visualProperty": "EDGE_LABEL" \n}```\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getMappings',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u'#/definitions/VisualStyleMappingModel'},
u'type': u'array'}}},
u'summary': u'Get all Visual Mappings for the Visual Style',
u'tags': [u'Visual Styles']},
u'post': {u'consumes': [u'application/json'],
u'description': u'Create a new Visual Mapping function and add it to the Visual Style specified by the `name` parameter. Existing mappings in the Visual Style will be overidden by the new mappings created.\n\nThe types of mapping available in Cytoscape are explained in depth [here](http://manual.cytoscape.org/en/stable/Styles.html#how-mappings-work). An example of the data format for each is included below. For additional details, such as what Visual Properties supported by each Mapping, click on the relevant JavaDoc API link.\n\n#### Discrete Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/DiscreteMapping.html)\n```\n{ "mappingType": "discrete",\n "mappingColumn": "interaction",\n\t "mappingColumnType": "String",\n\t "visualProperty": "EDGE_WIDTH", \n\t "map": [\n { "key" : "pd",\n "value" : "20"\n },\n { "key" : "pp",\n "value" : "1.5"\n }\n ]\n}```\n#### Continuous Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/ContinuousMapping.html)\n```\n{ "mappingType": "continuous",\n "mappingColumn": "Degree",\n "mappingColumnType": "Integer",\n "visualProperty": "NODE_SIZE",\n "points": [\n { "value" : 1,\n "lesser" : "20",\n "equal" : "20",\n "greater" : "20"\n },\n\t { "value" : 20,\n "lesser" : "120",\n "equal" : "120",\n "greater" : "220" }\n ]\n}```\n#### Passthrough Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/PassthroughMapping.html)\n```\n{ "mappingType": "passthrough",\n "mappingColumn": "name",\n "mappingColumnType": "String",\n "visualProperty": "EDGE_LABEL" \n}```\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'createMappings',
u'parameters': [{u'description': u'Name of the Visual Style',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'A list of new mappings.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/VisualStyleMappingModel'},
u'type': u'array'},
u'x-examples': {u'default': u'[{\n "mappingType": "continuous",\n "mappingColumn": "degree.layout",\n "mappingColumnType": "Integer",\n "visualProperty": "NODE_SIZE",\n "points": [\n {\n "value": 1,\n "lesser": "1.0",\n "equal": "40.0",\n "greater": "40.0"\n },\n {\n "value": 18,\n "lesser": "150.0",\n "equal": "150.0",\n "greater": "1.0"\n }\n ]\n }'}}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Add a new Visual Mapping',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}/mappings/{vpName}': {u'delete': {u'description': u'Deletes the Visual Property mapping specified by the `vpName` and `name` parameters.',
u'operationId': u'deleteMapping',
u'parameters': [{u'description': u'Name of the Visual Style containing the Visual Mapping',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string',
u'x-example': u'default'},
{u'description': u'Name of the Visual Property that the Visual Mapping controls',
u'in': u'path',
u'name': u'vpName',
u'required': True,
u'type': u'string',
u'x-example': u'NODE_SIZE'}],
u'produces': [u'application/json'],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Delete a Visual Mapping from a Visual Style',
u'tags': [u'Visual Styles']}},
u'/v1/styles/{name}/mappings/{vp}': {u'get': {u'description': u'Returns the Visual Mapping assigned to the Visual Property specified by the `name` and `vp` parameters.\n\nThe types of mapping available in Cytoscape are explained in depth [here](http://manual.cytoscape.org/en/stable/Styles.html#how-mappings-work). An example of the data format for each is included below. For additional details, such as what Visual Properties supported by each Mapping, click on the relevant JavaDoc API link.\n\n#### Discrete Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/DiscreteMapping.html)\n```\n{ "mappingType": "discrete",\n "mappingColumn": "interaction",\n\t "mappingColumnType": "String",\n\t "visualProperty": "EDGE_WIDTH", \n\t "map": [\n { "key" : "pd",\n "value" : "20"\n },\n { "key" : "pp",\n "value" : "1.5"\n }\n ]\n}```\n#### Continuous Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/ContinuousMapping.html)\n```\n{ "mappingType": "continuous",\n "mappingColumn": "Degree",\n "mappingColumnType": "Integer",\n "visualProperty": "NODE_SIZE",\n "points": [\n { "value" : 1,\n "lesser" : "20",\n "equal" : "20",\n "greater" : "20"\n },\n\t { "value" : 20,\n "lesser" : "120",\n "equal" : "120",\n "greater" : "220" }\n ]\n}```\n#### Passthrough Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/PassthroughMapping.html)\n```\n{ "mappingType": "passthrough",\n "mappingColumn": "name",\n "mappingColumnType": "String",\n "visualProperty": "EDGE_LABEL" \n}```\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'getMapping',
u'parameters': [{u'description': u'Name of the Visual Style containing the Visual Property mapping',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the Visual Property that the Visual Mapping controls',
u'in': u'path',
u'name': u'vp',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/VisualStyleMappingModel'}}},
u'summary': u'Get a Visual Mapping associated with the Visual Property',
u'tags': [u'Visual Styles']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Update the visual mapping specified by the `name` and `vp` parameters.\n\nThe types of mapping available in Cytoscape are explained in depth [here](http://manual.cytoscape.org/en/stable/Styles.html#how-mappings-work). An example of the data format for each is included below. For additional details, such as what Visual Properties supported by each Mapping, click on the relevant JavaDoc API link.\n\n#### Discrete Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/DiscreteMapping.html)\n```\n{ "mappingType": "discrete",\n "mappingColumn": "interaction",\n\t "mappingColumnType": "String",\n\t "visualProperty": "EDGE_WIDTH", \n\t "map": [\n { "key" : "pd",\n "value" : "20"\n },\n { "key" : "pp",\n "value" : "1.5"\n }\n ]\n}```\n#### Continuous Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/ContinuousMapping.html)\n```\n{ "mappingType": "continuous",\n "mappingColumn": "Degree",\n "mappingColumnType": "Integer",\n "visualProperty": "NODE_SIZE",\n "points": [\n { "value" : 1,\n "lesser" : "20",\n "equal" : "20",\n "greater" : "20"\n },\n\t { "value" : 20,\n "lesser" : "120",\n "equal" : "120",\n "greater" : "220" }\n ]\n}```\n#### Passthrough Mapping\n[JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/vizmap/mappings/PassthroughMapping.html)\n```\n{ "mappingType": "passthrough",\n "mappingColumn": "name",\n "mappingColumnType": "String",\n "visualProperty": "EDGE_LABEL" \n}```\n\nAdditional details on common Visual Properties can be found in the [Basic Visual Lexicon JavaDoc API](http://chianti.ucsd.edu/cytoscape-3.6.1/API/org/cytoscape/view/presentation/property/BasicVisualLexicon.html)',
u'operationId': u'updateMapping',
u'parameters': [{u'description': u'Name of the Visual Style containing the Visual Mapping',
u'in': u'path',
u'name': u'name',
u'required': True,
u'type': u'string'},
{u'description': u'Name of the Visual Property that the Visual Mapping controls',
u'in': u'path',
u'name': u'vp',
u'required': True,
u'type': u'string'},
{u'description': u'A list of new mappings.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u'#/definitions/VisualStyleMappingModel'},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update an existing Visual Mapping',
u'tags': [u'Visual Styles']}},
u'/v1/tables/count': {u'get': {u'description': u'Returns the number of global tables.',
u'operationId': u'getTableCount',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/CountModel'}}},
u'summary': u'Get number of global tables',
u'tags': [u'Tables']}},
u'/v1/ui': {u'get': {u'description': u'Returns the status of the Desktop',
u'operationId': u'getDesktop',
u'parameters': [],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Cytoscape Desktop Availability'}}},
u'summary': u'Get status of Desktop',
u'tags': [u'User Interface']}},
u'/v1/ui/lod': {u'put': {u'description': u'Switch between full graphics details <---> fast rendering mode.\n\nReturns a success message.',
u'operationId': u'updateLodState',
u'parameters': [],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/MessageModel'}}},
u'summary': u'Toggle level of graphics details (LoD)',
u'tags': [u'User Interface']}},
u'/v1/ui/panels': {u'get': {u'description': u'Returns all CytoPanels and their statuses.',
u'operationId': u'getAllPanelStatus',
u'parameters': [],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'items': {u'$ref': u"#/definitions/Cytoscape's GUI Panel Element"},
u'type': u'array'}}},
u'summary': u'Get status of all CytoPanels',
u'tags': [u'User Interface']},
u'put': {u'consumes': [u'application/json'],
u'description': u'Updates the status(es) of available CytoPanels.',
u'operationId': u'updatePanelStatus',
u'parameters': [{u'description': u'A list of CytoPanels with states.',
u'in': u'body',
u'name': u'body',
u'required': True,
u'schema': {u'items': {u'$ref': u"#/definitions/Cytoscape's GUI Panel Element"},
u'type': u'array'}}],
u'responses': {u'default': {u'description': u'successful operation'}},
u'summary': u'Update CytoPanel states',
u'tags': [u'User Interface']}},
u'/v1/ui/panels/{panelName}': {u'get': {u'description': u'Returns the status of the CytoPanel specified by the `panelName` parameter.',
u'operationId': u'getPanelStatus',
u'parameters': [{u'description': u'Name of the CytoPanel',
u'in': u'path',
u'name': u'panelName',
u'required': True,
u'type': u'string'}],
u'produces': [u'application/json;charset=utf-8'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u"#/definitions/Cytoscape's GUI Panel Element"}}},
u'summary': u'Get status of a CytoPanel',
u'tags': [u'User Interface']}},
u'/v1/version': {u'get': {u'description': u'Returns the version of the current Cytoscape REST API.',
u'operationId': u'getCytoscapeVersion',
u'parameters': [],
u'produces': [u'application/json'],
u'responses': {u'200': {u'description': u'successful operation',
u'schema': {u'$ref': u'#/definitions/Cytoscape and CyREST API Versions'}}},
u'summary': u'Get Cytoscape and REST API version',
u'tags': [u'REST Service', u'Cytoscape System']}}}
In [106]:
res["paths"]['/diffusion']["get"]
---------------------------------------------------------------------------
KeyError Traceback (most recent call last)
<ipython-input-106-1c710e6f00d7> in <module>()
----> 1 res["paths"]['/v1/diffusion']["get"]
KeyError: '/v1/diffusion'
In [104]:
paths=res["paths"]
url_path='/v1/networks/{networkId}/groups/{groupNodeId}/collapse'
#url_path='/cyndex2/v1/networks'
url_path='/v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass'
url_path="/v1/networks/{networkId}/tables/{tableType}"
def write_function(url_path=url_path,paths=paths):
function=paths[url_path]
all_text=""
for request_type in function.keys():
if request_type not in ["get","post","put", "delete"]:
print request_type, url_path, "\n\n"
else:
url_=url_path
python_function=function[request_type]
f_name=python_function['operationId']
f_desc=python_function['description']
f_desc=f_desc.rstrip("\n")
f_desc=f_desc.replace("\n","\n ")
parameters=python_function['parameters']
f_para=[]
f_para_end=[]
f_para_desc=[]
f_para_desc_end=[]
f_para_not_in_url=[]
for p in parameters:
pname=p["name"]
required=p['required']
if "{"+pname+"}" in url_:
url_=url_.replace("{"+pname+"}","'+str(%s)+'" %pname)
else:
f_para_not_in_url.append(pname)
#if not required:
#if pname != "body":
# print "\n\n!!", request_type, url_path, python_function,"\n\n", pname
#f_para.append(pname+"=None")
#else:
if "description" in p.keys():
pdesc=" :param "+pname+": "+p["description"]
if not required:
pdesc=pdesc+" -- Not required, can be None"
f_para.append(pname)
f_para_desc.append(pdesc)
else:
pdesc=" :param "+pname+": None"
if not required:
pdesc=pdesc+" -- Not required, can be None"
f_para_end.append(pname)
f_para_desc_end.append(pdesc)
for p in f_para_end:
f_para.append(p)
for p in f_para_desc_end:
f_para_desc.append(p)
f_para.append("verbose=None")
f_para=", ".join(f_para)
f_para_desc.append(" :param verbose: print more")
f_para_desc="\n".join(f_para_desc)
rets=python_function['responses']
f_returns=[]
for r in rets.keys():
r_=r+": "+rets[r]['description']
f_returns.append(r_)
# if len(f_returns) > 0:
# f_returns="; ".join(f_returns)
# else:
# f_returns="Nothing"
if url_[-1] != ")" :
url_=url_ + "'"
f_text="def "+f_name+"("+f_para+'):\n """\n '+f_desc+"\n\n"+f_para_desc+'\n'
if len(f_returns) > 0:
f_text=f_text+ '\n :returns: '+"; ".join(f_returns)
f_text=f_text+'\n """\n'
if url_.split("/")[1] == "v1":
url_=url_.split("/v1/")[1]
if url_[:4] != 'str(':
url_="'"+url_
url_='self.url+'+url_
else:
f_text=f_text+"\n surl=self.url\n sv=surl.split('/')[-1]\n surl=surl.rstrip(sv+'/')"
url_=url_.replace('/v1/',"/'+sv+'/")
if url_[:4] != 'str(':
url_="'"+url_
url_='surl+'+url_
if request_type == "get":
if len(f_para_not_in_url) > 0 :
PARAMS_GET=[]
for p in f_para_not_in_url:
PARAMS_GET.append("'"+p+"':"+p)
PARAMS_GET=", PARAMS={"+", ".join(PARAMS_GET)+"}"
else:
PARAMS_GET=", PARAMS=None"
f_text=f_text+'\n response=api(url='+url_+PARAMS_GET+', method="GET", verbose=verbose, parse_params=False)\n\treturn response'
elif request_type == "delete":
f_text=f_text+'\n response=api(url='+url_+', method="DELETE", verbose=verbose)\n\treturn response'
elif request_type == "put":
if "body" in f_para:
f_text=f_text+'\n response=api(url='+url_+', method="PUT", body=body, verbose=verbose)\n\treturn response'
else:
f_text=f_text+'\n response=api(url='+url_+', method="PUT", verbose=verbose)\n\treturn response'
elif request_type == "post":
f_para=f_para.split(", ")
f_para_=[ s for s in f_para if s != "verbose=None" ]
#f_para_=[ s for s in ]
PARAMS="PARAMS=set_param(["
plabels=[]
for p in f_para_:
plabels.append("'"+p+"'")
plabels=",".join(plabels)
PARAMS=PARAMS+plabels+"],["+",".join(f_para_)+"])"
f_text=f_text+'\n\t'+PARAMS
f_text=f_text+'\n\tresponse=api(url='+url_+', PARAMS=PARAMS, method="POST", verbose=verbose)\n\treturn response'
all_text=all_text+"\n"+f_text+"\n\n"
return all_text
print write_function(url_path=url_path,paths=paths)
def updateTable(networkId, tableType, body, class, verbose=None):
"""
Updates the table specified by the `tableType` and `networkId` parameters. New columns will be created if they do not exist in the target table.
Current limitations:
* Numbers are handled as Double
* List column is not supported in this version
:param networkId: SUID containing the table
:param tableType: Type of table
:param body: The data with which to update the table.
:param class: None -- Not required, can be None
:param verbose: print more
:returns: default: successful operation
"""
response=api(url=self.url+'networks/'+str(networkId)+'/tables/'+str(tableType)+'', method="PUT", body=body, verbose=verbose)
return response
def getTable(networkId, tableType, verbose=None):
"""
Returns the table specified by the `networkId` and 'tableType' parameters.
:param networkId: SUID of the network containing the table
:param tableType: Table type
:param verbose: print more
:returns: 200: successful operation
"""
response=api(url=self.url+'networks/'+str(networkId)+'/tables/'+str(tableType)+'', PARAMS=None, method="GET", verbose=verbose, parse_params=False)
return response
In [111]:
for p in res["paths"].keys() :
ns=p.split("/")
print ns
if ns[1]=="v1":
ns=ns[0]
else:
ns=ns[1]
print ns
[u'', u'v1', u'networks', u'{networkId}', u'groups', u'{groupNodeId}', u'collapse']
[u'', u'v1', u'networks', u'{networkId}', u'groups', u'{groupNodeId}', u'expand']
[u'', u'reactomefiviz', u'v1', u'pathwayTree']
reactomefiviz
[u'', u'v1', u'networks', u'{networkId}', u'views', u'count']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'first.pdf']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'{objectType}', u'{objectId}']
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}.csv']
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'{nodeId}', u'neighbors']
[u'', u'reactomefiviz', u'v1', u'cluster']
reactomefiviz
[u'', u'v1', u'session']
[u'', u'v1', u'session', u'name']
[u'', u'v1', u'collections', u'{networkId}', u'tables', u'{tableType}', u'columns']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'network', u'{visualProperty}', u'bypass']
[u'', u'diffusion', u'v1', u'currentView', u'diffuse_with_options']
diffusion
[u'', u'v1', u'networks', u'currentNetwork']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'network', u'{visualProperty}']
[u'', u'v1', u'apply', u'layouts', u'{algorithmName}', u'{networkId}']
[u'', u'enrichmentmap', u'model', u'{network}']
enrichmentmap
[u'', u'v1', u'commands', u'{namespace}', u'{command}']
[u'', u'v1', u'networks', u'{networkId}']
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'{objectType}', u'{objectId}', u'{visualProperty}']
[u'', u'v1', u'styles', u'{name}', u'defaults']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'{objectType}']
[u'', u'v1', u'styles', u'visualproperties', u'{visualProperty}']
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}.tsv']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}.cx']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}.pdf']
[u'', u'v1', u'collections']
[u'', u'v1', u'styles']
[u'', u'v1', u'networks.json']
[u'', u'enrichmentmap', u'expressions', u'{network}']
enrichmentmap
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'{nodeId}', u'pointer']
[u'', u'cyndex2', u'v1', u'networks', u'{suid}']
cyndex2
[u'', u'reactomefiviz', u'v1', u'buildFISubNetwork']
reactomefiviz
[u'', u'v1', u'collections', u'{networkId}', u'tables']
[u'', u'v1', u'networks', u'{networkId}', u'tables']
[u'', u'v1']
[u'', u'v1', u'apply', u'fit', u'{networkId}']
[u'', u'diffusion', u'v1', u'{networkSUID}', u'views', u'{networkViewSUID}', u'diffuse_with_options']
diffusion
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}', u'columns']
[u'', u'reactomefiviz', u'v1', u'fiVersions']
reactomefiviz
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}', u'rows', u'{primaryKey}']
[u'', u'v1', u'networks', u'{networkId}', u'edges', u'{edgeId}', u'isDirected']
[u'', u'']
[u'', u'v1', u'styles', u'{name}', u'dependencies']
[u'', u'v1', u'networks', u'count']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}']
[u'', u'v1', u'apply', u'styles']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'{objectType}', u'{objectId}', u'{visualProperty}', u'bypass']
[u'', u'v1', u'version']
[u'', u'v1', u'apps']
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'{nodeId}']
[u'', u'v1', u'ui', u'panels']
[u'', u'v1', u'apply', u'layouts', u'copycat', u'{sourceViewSUID}', u'{targetViewSUID}']
[u'', u'v1', u'collections', u'{networkId}', u'tables', u'{tableType}', u'columns', u'{columnName}']
[u'', u'v1', u'collections', u'count']
[u'', u'v1', u'commands', u'{namespace}']
[u'', u'diffusion', u'v1', u'{networkSUID}', u'views', u'{networkViewSUID}', u'diffuse']
diffusion
[u'', u'v1', u'networks', u'{networkId}', u'edges']
[u'', u'v1', u'networks', u'{networkId}', u'edges', u'selected']
[u'', u'v1', u'collections', u'{networkId}', u'subnetworks']
[u'', u'reactomefiviz', u'v1', u'moduleEnrichment', u'{type}']
reactomefiviz
[u'', u'v1', u'networks', u'{networkId}', u'views', u'first.png']
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}', u'rows', u'{primaryKey}', u'{columnName}']
[u'', u'enrichmentmap', u'expressions', u'{network}', u'{node}']
enrichmentmap
[u'', u'v1', u'ui']
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'selected']
[u'', u'v1', u'networks', u'{networkId}', u'groups', u'{groupNodeId}']
[u'', u'reactomefiviz', u'v1', u'enrichment', u'{type}']
reactomefiviz
[u'', u'diffusion', u'v1', u'currentView', u'diffuse']
diffusion
[u'', u'cyndex2', u'v1']
cyndex2
[u'', u'v1', u'networks', u'{networkId}', u'edges', u'count']
[u'', u'v1', u'apply', u'edgebundling', u'{networkId}']
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}', u'columns', u'{columnName}']
[u'', u'v1', u'ui', u'panels', u'{panelName}']
[u'', u'v1', u'styles', u'{name}.json']
[u'', u'v1', u'networks', u'{networkId}', u'nodes']
[u'', u'v1', u'apply', u'styles', u'{styleName}', u'{networkId}']
[u'', u'v1', u'networks', u'views', u'currentNetworkView']
[u'', u'v1', u'networks', u'{networkId}', u'groups', u'count']
[u'', u'v1', u'styles', u'count']
[u'', u'v1', u'networks', u'{networkId}', u'edges', u'{edgeId}']
[u'', u'v1', u'styles', u'{name}', u'mappings', u'{vpName}']
[u'', u'reactomefiviz', u'v1', u'ReactomePathwayEnrichment']
reactomefiviz
[u'', u'v1', u'networks', u'{networkId}', u'tables', u'{tableType}', u'rows']
[u'', u'cyndex2', u'v1', u'networks', u'current']
cyndex2
[u'', u'v1', u'collections', u'{networkId}.cx']
[u'', u'v1', u'styles', u'visualproperties', u'{vp}', u'values']
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'count']
[u'', u'v1', u'styles', u'{name}']
[u'', u'v1', u'collections', u'{networkId}', u'tables', u'{tableType}']
[u'', u'v1', u'tables', u'count']
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'selected', u'neighbors']
[u'', u'v1', u'styles', u'{name}', u'mappings']
[u'', u'cyndex2', u'v1', u'networks']
cyndex2
[u'', u'reactomefiviz', u'v1', u'exportPathwayDiagram']
reactomefiviz
[u'', u'v1', u'commands']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'first']
[u'', u'v1', u'styles', u'visualproperties']
[u'', u'v1', u'apply', u'layouts', u'{algorithmName}', u'parameters']
[u'', u'v1', u'apply', u'layouts', u'{algorithmName}']
[u'', u'v1', u'networks', u'{networkId}', u'nodes', u'{nodeId}', u'adjEdges']
[u'', u'v1', u'styles', u'{name}', u'mappings', u'{vp}']
[u'', u'v1', u'networks']
[u'', u'v1', u'networks', u'{networkId}', u'views']
[u'', u'v1', u'networks', u'{networkId}', u'edges', u'{edgeId}', u'{type}']
[u'', u'v1', u'networks.names']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}', u'network']
[u'', u'v1', u'networks', u'{networkId}', u'groups']
[u'', u'v1', u'gc']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}.svg']
[u'', u'v1', u'apply', u'layouts']
[u'', u'v1', u'apply', u'layouts', u'{algorithmName}', u'columntypes']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'{viewId}.png']
[u'', u'v1', u'networks', u'{networkId}', u'views', u'first.svg']
[u'', u'v1', u'ui', u'lod']
[u'', u'v1', u'styles', u'{name}', u'defaults', u'{vp}']
In [119]:
tmp_out_folder="/Users/jboucas/tmp_out_cytoscape/"
for p in res["paths"].keys() :
ns=p.split("/")
try:
if ns[1]=="v1":
ns=ns[2]
else:
ns=ns[1]
except:
ns=""
if ns not in ["enrichmentmap","diffusion","cyndex2","reactomefiviz"]:
print ns, p
if p not in ["/v1/commands/{namespace}"]:
if ns in [""]:
#print p
#print "*******************"
a=write_function(url_path=p,paths=paths)
if ns == "":
print "py"
with open(tmp_out_folder+ns+".py", "a") as fout:
try:
fout.write( str(a) )
except:
print "\n\n********",p,"***********"
print a
#try:
# print p.split("/")[2], "\t", p
#except:
# print "!!!", p
networks /v1/networks/{networkId}/groups/{groupNodeId}/collapse
networks /v1/networks/{networkId}/groups/{groupNodeId}/expand
networks /v1/networks/{networkId}/views/count
networks /v1/networks/{networkId}/views/first.pdf
networks /v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}
networks /v1/networks/{networkId}/tables/{tableType}.csv
networks /v1/networks/{networkId}/nodes/{nodeId}/neighbors
session /v1/session
session /v1/session/name
collections /v1/collections/{networkId}/tables/{tableType}/columns
networks /v1/networks/{networkId}/views/{viewId}/network/{visualProperty}/bypass
networks /v1/networks/currentNetwork
networks /v1/networks/{networkId}/views/{viewId}/network/{visualProperty}
apply /v1/apply/layouts/{algorithmName}/{networkId}
commands /v1/commands/{namespace}/{command}
networks /v1/networks/{networkId}
networks /v1/networks/{networkId}/tables/{tableType}
networks /v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}/{visualProperty}
styles /v1/styles/{name}/defaults
networks /v1/networks/{networkId}/views/{viewId}/{objectType}
styles /v1/styles/visualproperties/{visualProperty}
networks /v1/networks/{networkId}/tables/{tableType}.tsv
networks /v1/networks/{networkId}/views/{viewId}.cx
networks /v1/networks/{networkId}/views/{viewId}.pdf
collections /v1/collections
styles /v1/styles
networks.json /v1/networks.json
networks /v1/networks/{networkId}/nodes/{nodeId}/pointer
collections /v1/collections/{networkId}/tables
networks /v1/networks/{networkId}/tables
/v1
py
apply /v1/apply/fit/{networkId}
networks /v1/networks/{networkId}/tables/{tableType}/columns
networks /v1/networks/{networkId}/tables/{tableType}/rows/{primaryKey}
networks /v1/networks/{networkId}/edges/{edgeId}/isDirected
/
py
styles /v1/styles/{name}/dependencies
networks /v1/networks/count
networks /v1/networks/{networkId}/views/{viewId}
apply /v1/apply/styles
networks /v1/networks/{networkId}/views/{viewId}/{objectType}/{objectId}/{visualProperty}/bypass
version /v1/version
apps /v1/apps
networks /v1/networks/{networkId}/nodes/{nodeId}
ui /v1/ui/panels
apply /v1/apply/layouts/copycat/{sourceViewSUID}/{targetViewSUID}
collections /v1/collections/{networkId}/tables/{tableType}/columns/{columnName}
collections /v1/collections/count
commands /v1/commands/{namespace}
networks /v1/networks/{networkId}/edges
networks /v1/networks/{networkId}/edges/selected
collections /v1/collections/{networkId}/subnetworks
networks /v1/networks/{networkId}/views/first.png
networks /v1/networks/{networkId}/tables/{tableType}/rows/{primaryKey}/{columnName}
ui /v1/ui
networks /v1/networks/{networkId}/nodes/selected
networks /v1/networks/{networkId}/groups/{groupNodeId}
networks /v1/networks/{networkId}/edges/count
apply /v1/apply/edgebundling/{networkId}
networks /v1/networks/{networkId}/tables/{tableType}/columns/{columnName}
ui /v1/ui/panels/{panelName}
styles /v1/styles/{name}.json
networks /v1/networks/{networkId}/nodes
apply /v1/apply/styles/{styleName}/{networkId}
networks /v1/networks/views/currentNetworkView
networks /v1/networks/{networkId}/groups/count
styles /v1/styles/count
networks /v1/networks/{networkId}/edges/{edgeId}
styles /v1/styles/{name}/mappings/{vpName}
networks /v1/networks/{networkId}/tables/{tableType}/rows
collections /v1/collections/{networkId}.cx
styles /v1/styles/visualproperties/{vp}/values
networks /v1/networks/{networkId}/nodes/count
styles /v1/styles/{name}
collections /v1/collections/{networkId}/tables/{tableType}
tables /v1/tables/count
networks /v1/networks/{networkId}/nodes/selected/neighbors
styles /v1/styles/{name}/mappings
commands /v1/commands
networks /v1/networks/{networkId}/views/first
styles /v1/styles/visualproperties
apply /v1/apply/layouts/{algorithmName}/parameters
apply /v1/apply/layouts/{algorithmName}
networks /v1/networks/{networkId}/nodes/{nodeId}/adjEdges
styles /v1/styles/{name}/mappings/{vp}
networks /v1/networks
networks /v1/networks/{networkId}/views
networks /v1/networks/{networkId}/edges/{edgeId}/{type}
networks.names /v1/networks.names
networks /v1/networks/{networkId}/views/{viewId}/network
networks /v1/networks/{networkId}/groups
gc /v1/gc
networks /v1/networks/{networkId}/views/{viewId}.svg
apply /v1/apply/layouts
apply /v1/apply/layouts/{algorithmName}/columntypes
networks /v1/networks/{networkId}/views/{viewId}.png
networks /v1/networks/{networkId}/views/first.svg
ui /v1/ui/lod
styles /v1/styles/{name}/defaults/{vp}
In [90]:
import requests
In [40]:
help(requests.put)
Help on function put in module requests.api:
put(url, data=None, **kwargs)
Sends a PUT request.
:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary (will be form-encoded), bytes, or file-like object to send in the body of the :class:`Request`.
:param json: (optional) json data to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:return: :class:`Response <Response>` object
:rtype: requests.Response
In [70]:
help(requests.get)
Help on function get in module requests.api:
get(url, params=None, **kwargs)
Sends a GET request.
:param url: URL for the new :class:`Request` object.
:param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:return: :class:`Response <Response>` object
:rtype: requests.Response
In [ ]:
- [x] non required parameters to the end of the function
- [x] non required parameters in GET are done as params
- [x] api( parse_params=True) and False for these special get
- [ ] put non required parameters get instructions that they need to go on the body (body needs to be present)
Content source: idekerlab/py2cytoscape
Similar notebooks: