Team:UESTC Software/Documentation
API
Photo From © PEXELS
Service API Documentation
Developers can reuse the function of our software quickly by use Service API.
1 Get minimal gene set
| URL | /api/cegRecord/fetchCeg.php |
| GET | id |
| Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the minimal gene set filtered. |
| Example | http://yourHost.com/api/cegRecord/fetchCeg.php?id=01020304 |
2 Compare two minimal gene sett
| URL | /api/cegRecord/compare.php |
| GET | id |
| Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the minimal gene set. Statics is the statistical value. |
| Example | http://yourHost.com/api/cegRecord/compare.php?id=01020304+05060708 |
3 Download minimal gene set with CSV format
| URL | api/download/cegCSV.php |
| GET | id |
| Return | File with CSV format. |
| Example | http://yourHost.com/api/download/cegCSV.php?id=01020304 |
4 Download minimal gene set with XML format
| URL | api/download/cegXML.php |
| GET | id |
| Return | File with XML format. |
| Example | http://yourHost.com/api/download/cegXML.php?id=01020304 |
5 Get module with whole minimal gene set
| URL | api/kegg/entireModule.php |
| GET | id |
| Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of module results. |
| Example | http://yourHost.com/api/kegg/entireModule.php?id=01020304 |
6 Get pathway with whole minimal gene set
| URL | api/kegg/entirePathway.php |
| GET | id |
| Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of pathway results. |
| Example | http://yourHost.com/api/kegg/entireModule.php?id=01020304 |
7 Get module with gene set that only about metabolism
| URL | api/kegg/metabolicModule.php |
| GET | id |
| Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of module results. |
| Example | http://yourHost.com/api/kegg/metabolicModule.php?id=01020304 |
8 Get pathway with gene set that only about metabolism
| URL | /api/kegg/metabolicPathway.php |
| GET | id |
| Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of pathway results. |
| Example | http://yourHost.com/api/kegg/metabolicPathway.php?id=01020304 |
Service Page Documentation
Service Page can be visited directly to view the corresponding result.
1 Page of Module wtih whole minimal gene set
| URL | /app/page/mapEntireModule.php |
| GET | id |
| Return | Module list |
| Example | http://yourHost.com/app/page/mapEntireModule.php?id=01020304 |
2 Page of pathway wtih whole minimal gene set
| URL | /app/page/mapEntirePathway.php |
| GET | id |
| Return | Pathway list |
| Example | http://yourHost.com/app/page/mapEntireModule.php?id=01020304 |
3 Page of module with gene set that only about metabolism
| URL | /app/page/mapMetaModule.php |
| GET | id |
| Return | Module list |
| Example | http://yourHost.com/app/page/mapMetaModule.php?id=01020304 |
4 Page of pathway wtih gene set that only about metabolism
| URL | /app/page/mapMetaPathway.php |
| GET | id |
| Return | Module list |
| Example | http://yourHost.com/app/page/mapMetaPathway.php?id=01020304 |