Comment on page
Learn to access the DNAnexus Platform programmatically.
The DNAnexus Platform can be accessed programmatically via an API using HTTP requests to the DNAnexus API servers. Each API method may receive zero or more arguments as fields in a JSON string, and may return some results, always as a JSON string. For specifics on how to call an API method, see Protocols and Authentication.
You can expect URLs corresponding to API methods to be always of the following form:
Where the subject can be one of the following:
- 1.The word "system", for system-wide methods. These methods are for search functionality, as well as other utilities that do not fall under a specific entity class. Example:
/system/findDataObjectstakes in query parameters and returns a list of matching data objects.
- 2.An entity class for which a new instance may be created Example:
/file/newcreates a new file data object that can be written to
- 3.An entity ID, for methods that act on existing instances, where the method name usually is some verb acting on the object. Example:
/file-xxxx/closecloses the file object with ID "file-xxxx"
When describing an input or output to an API method, the data type is given in bold. For example:
tagsarray of strings Tags to be added to the file.
The following data types are used: number, int, timestamp, string, boolean, null, array, mapping.
The following concepts in the DNAnexus API affect the operation of a large number of API routes: