NDEx REST API
This [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) document defines the Network Data Exchange (NDEx) REST API which is used to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This OpenAPI Specification document defines the Network Data Exchange (NDEx) REST API which is used to communicate with NDEx public and private servers.
This document and all references to the NDEx REST API, source code and ancillary documentation are copyrighted: © 2013-2020, The Regents of the University of California, The Cytoscape Consortium. All rights reserved. Please abide with the Terms of Use, Licensing and Sources. Likewise, the Swagger-UI document reader that displays this OpenAPI document is copyrighted by Smartbear Software. Its open-source software license is found here.
Google's OAuth2 (OpenID Connect) login is not currently supported. It will be added when the Swagger-UI document reader permits. Basic Authentication and all other API endpoints are supported.
The full NDEx API specification is found on the official NDEx API document webpage.
This OpenAPI project is developed and maintained by [Mike Fidel](mailto:mikefidel.us@gmail.com). Please submit bug reports, enhancement requests and questions through the project's GitHub's Issue Tracking.
Endpoints 55
Admin
- GETGet Server Status
/admin/statusGet the current operational status of an NDEx server. Use this function to check if the NDEx server is running or stopped, as well as list important server…
Batch
- POSTGet Groups by UUIDs
/batch/groupReturns a JSON array of Group objects. The HTTP request payload contains a JSON array of UUIDs which identify which Group objects to fetch. No more than 2000… - POSTExport Networks
/batch/network/exportCreates network export tasks for the set of networks specified by the networkids property in the network export request payload. The format which to export is… - POSTGet Network Permissions by UUIDs
/batch/network/permissionReturns what permissions the authenticated user has on the given list of network UUIDs. The response payload is a JSON map in which the keys are network UUIDs… - POSTGet Network Summaries of UUIDs
/batch/network/summaryReturns a JSON array of Network Summary objects. The HTTP request payload contains a JSON array of UUIDs which identify which Network Summary objects to… - POSTGet Users by UUIDs
/batch/userReturns a JSON array of User objects. The HTTP request payload contains a JSON array of UUIDs which identify which User objects to fetch. No more than 2000…
Group
- POSTCreate a Group
/groupCreates a new group owned by the authenticated user. The following properties can be set for the new group groupName image website description A URL link… - GETGet a Group
/group/:groupidRetrieves the group specified by groupid (i.e. Group UUID). Returns an error if the group is not found. - PUTUpdate a Group
/group/:groupidUpdates the group metadata associated with the groupid path parameter. Returns an error if: the group is not found the user is not the owner of the network set - DELETEDelete a Group
/group/:groupidDeletes the group specified by the groupid path parameter. Returns an error if: the roup is not found the authenticated user does not have authorization to… - GETGet Members of a Group
/group/:groupid/membershipRetrieves members of the group associated with the groupid path parameter. The type query parameter can filter which membership types are returned. All… - PUTAdd or Update a Group Member
/group/:groupid/membership?userid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&type=GROUPADMINUpdates the group membership associated with the groupid path parameter. An error is returned if: any path or query parameter is omitted the authenticated… - DELETERemove a Group Member
/group/:groupid/membership?userid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxRemoves the group member associated with the userid query parameter. An error is returned if: the group does not exist the authenticated user is not… - GETGet Permissions (Two Options)
/group/:groupid/permissionOption 1 - Get Group Permission for a Specific Network Using the networkId= query parameter: Returns the explicit permission the specified groupid has on the…
Network
- POSTCreate a CX Network
/networkCreates a CX Network. If the POSTed content-type is multipart/form-data, the input CX data is expected to be in the CXNetworkStream field. If the POSTed… - GETGet Complete Network in CX Format
/network/:networkidReturns the specified network as CX. This is performed as a monolithic operation, so it is advisable for applications to first use the getNetworkSummary… - PUTUpdate a CX Network
/network/:networkidUpdates the specified network with new content, based on CX data. If the POSTed content-type is multipart/form-data, the input CX data is expected to be in… - DELETEDelete a network
/network/:networkidDeletes the network specified by networkid. There is no method to undo a deletion, so care should be exercised. The specified network must be owned by the… - GETGet Access Key of Network
/network/:networkid/accesskeyReturns an access key to the user. This access key will allow any user to have read access to this network regardless if that user has READ permissions on… - PUTDisable/Enable Access Key on Network
/network/:networkid/accesskey?action=enableThis operations turns the access key on and off. Returns an access key when query parameter action=enable. Returns a status code of 204 (no payload content)… - GETGet Network CX Metadata Collection
/network/:networkid/aspectReturns the CX metadata collection of the network specified by networkid. Errors if the networkid does not correspond to an existing network. - GETGet Network Aspect as CX
/network/:networkid/aspect/:aspectNameReturns a JSON array of CX elements from the aspect specified by the aspectName path parameter from the network specified by networkid. The size parameter is… - GETGet Network Aspect Metadata
/network/:networkid/aspect/:aspectName/metadataReturns the CX metadata for the specified aspect of the network specified by networkid. Errors if the networkid does not correspond to an existing network - PUTUpdate Network Aspects
/network/:networkid/aspectsUpdates aspects of the network specified by networkid. Put data contains a CX object which includes the specified aspects that will be used to overwrite or… - POSTClone a Network
/network/:networkid/copyCreates a clone of the network specified by networkid (UUID )into the signed in user's account. The URL of the cloned network is returned to the client. - PUTUpdate Network Profile
/network/:networkid/profileUpdates the profile information of the network specified by networkid based on a POSTed JSON object specifying the attributes to update. Any profile… - PUTSet Network Properties
/network/:networkid/propertiesUpdates the NetworkAttributes aspect of the network specified by networkid based on the list of NdexPropertyValuePair objects in the PUT data. Errors if: the… - GETGet Network Provenance
/network/:networkid/provenanceReturns the Provenance aspect of the network specified by networkid. The returned value is a JSON *ProvenanceEntity* object which in turn contains a tree… - PUTSet Network Provenance
/network/:networkid/provenanceUpdates the Provenance aspect of the network specified by networkid to be the *ProvenanceEntity* object of the PUT data. The *ProvenanceEntity* object is… - GETGet Network Sample
/network/:networkid/sampleReturns a sample subnetwork of the network specified by networkid. The default sample network is created based on an arbitrary selection of 500 edges, created… - PUTSet Sample Network
/network/:networkid/sampleSets the example network for the network specified by networkid. The sample network is specified by the CX data in the request payload. Errors if: the… - GETGet a Network Summary
/network/:networkid/summaryRetrieves a NetworkSummary JSON object based on the network specified by networkId. A NetworkSummary object is a subset of a network object. It is used to… - PUTUpdate Network Profile and Properties
/network/:networkid/summaryThe JSON request payload contains key/value pairs that overwrite the corresponding properties of a given network. at this time, only the following properties… - PUTSet Network System Properties
/network/:networkid/systempropertySets the network system properties which describe the network's status in a particular NDEx server. These properties are not part of the corresponding CX…
Network Set
- POSTCreate a Network Set
/networksetCreates a new network set. A URL link associated with the newly created network set is returned in the response payload upon successful completion. The… - GETGet a Network Set
/networkset/:networksetidRetrieves the network set specified by the networksetid (UUID) path parameter. An optional access key query parameter allows any user to have read access to… - PUTUpdate a Network Set
/networkset/:networksetidUpdates the network set specified by the networksetid (UUID) path parameter. Modifies the specified network set's name and description properties only.… - DELETEDelete a Network Set
/networkset/:networksetidDeletes the network set specified by the networksetid (UUID) path parameter. Returns an error when: the user is not the owner of the nework set the network… - POSTAdd Networks to Network Set
/networkset/:networksetid/membersAdds networks to a network set. The HTTP request payload holds an array containing one or more networksetid's (UUID's) that denote the networks to add. An… - DELETEDelete Networks from Network Set
/networkset/:networksetid/membersDeletes one or more networks belonging to a network set. The HTTP request payload holds an array containing one or more networkSetId's (UUID's) that denote… - PUTUpdate Network Set System Properties
/networkset/:networksetid/systempropertySets the system properties for the network set specified by networksetid (UUID). At this time, the only supported system property is showcase. An error is…
Search
- POSTSearch Groups
/search/groupReturns a SearchResult object containing an array of Group objects that have text matching that being searched for. The total number of Group objects meeting… - POSTSearch Networks
/search/networkReturns an array of NetworkSummary objects, and returns the total number of objects found that meet the search criterion. The search criterion is found in the… - POSTSearch Networks by Gene/Protein
/search/network/genesReturns an array of Network Summary objects, and returns the total number of objects found that meet the search criterion. The searchString property contains… - POSTInterconnect Query
/search/network/:networkid/interconnectqueryReturns a CX Network that is a neighborhood subnetwork where all the paths must start and end at one of the query nodes in the network specified by networkid.… - POSTQuery Network
/search/network/:networkid/queryReturns a CX Network that is a neighborhood subnetwork of the network specified by networkid. The query finds the subnetwork by a traversal of the network… - POSTSearch Users
/search/userReturns a SearchResult object containing an array of User objects that have text matching that being searched for. The total number of User objects meeting…
Task
- GETGet User's Tasks
/taskReturns a JSON array of *Task* objects owned by the authenticated user with the specified status. The array is ordered by task creation time. If the status… - GETGet a Task by Task UUID
/task/:taskidReturns the *Task* object associated with the taskid path parameter. An error is returned if: the task does not exist the authenticated user does not own the… - DELETEDelete a Task
/task/:taskidDeletes the task associated with the taskid path parameter. An error is returned if: the task does not exist the authenticated user does not own the specified… - GETDownload Exported File by Task UUID
/task/:taskid/file?download=trueReturns the file exported by the task specified in the taskid path parameter. An error is returned if: the task does not exist the authenticated user does not…
User
- GETGet User's Group Memberships
/user/:userid/membershipOption 1 - Using the groupId= query parameter: Returns the permission that the user specified by the userid* path parameter has on that group. An empty object… - GETGet All Network Sets Owned by a User
/user/:userid/networksetsReturns a list of *Network Set* objects owned by the user identified in the userid path parameter. - GETGet User's Account Page Networks
/user/:userid/networksummaryReturns a list of *NetworkSummary* objects of which: the user owns the networks are shared with the user directly Userid path parameter must be an… - GETGet User's Permission for Networks
/user/:userid/permission?networkId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxReturns the permissions assigned to the authenticated user for the specified networkId. Maps the networkId UUID to the highest permission assigned to the…
API details
- Base URL
http://www.ndexbio.org/v2http://{Host}/{Version}- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 55 operations on 41 pathsGET 20POST 16PUT 13DELETE 6
- Main resources
- Network 20Group 8Network Set 7Search 6Batch 5Task 4User 4Admin 1
- Response formats
application/jsontext/plainapplication/octet-stream- Description format
- OpenAPI 3.0.2, API version
2.4.5 - Links
- OpenAPI document
- Listed from
- NDEx's published OpenAPI description (ndexbio/openapi-specification) (MIT)
How to test the NDEx REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the NDEx REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Server Status” (GET /admin/status), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the NDEx REST API?
This [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) document defines the Network Data Exchange (NDEx) REST API which is used to… It is listed under Data & analytics and has 55 endpoints.
Who publishes the NDEx REST API?
It is listed from NDEx's public API description (an OpenAPI document), not published by NDEx on Swastik Codes. Anyone who controls ndexbio.org can claim the profile by adding a DNS TXT record.
What is the base URL of the NDEx REST API?
Its description lists 2 base URLs: http://www.ndexbio.org/v2, http://{Host}/{Version}. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the NDEx REST API?
With HTTP Basic authentication (username and password).
How many endpoints does the NDEx REST API have?
55 operations on 41 paths (20 GET, 16 POST, 13 PUT, 6 DELETE). The largest groups are Network, Group, Network Set, Search.
Is forking the NDEx REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.