 |
Page History
| Panel | ||||
|---|---|---|---|---|
| ||||
|
Naming
- case_id: Used to uniquely identify an image.
- execution_id: Used to uniquely identify an algorithm. A case_id can have multiple execution_ids associated with it.
- subject_id: Used to uniquely idenify a patient. A subject_id can have multiple case_ids associated with it.
/ImageLoader
The /ImageLoader resource is a Node application that extracts image metadata (such as width and height of the image) from the existing whole slide image and stores it in a Mongo database.
...
HTTP Verb | QueryEndpoint | Query Parameters(Input) | Output(Description) | Questions |
|---|---|---|---|---|
GET | /fileLocation | case_id | Get file location of imageNeed explanation | Used by caMicroscope viewer to give the image location to it's backend server |
| /mpp | case_id | Get mpp-x, mpp-y of the image | Need explanationUsed by the viewer to adjust the scales | |
| /metadata | case_id | Get all metadata of the image(width, height, mpp etc.) | Need explanationUsed by dynamic services to get width, height and file location of image | |
| /md5 | case_id | Get MD5 of the image fileNeed explanation | Used to check the MD5 to make sure image was loaded successfully | |
| POST | /json | metdata | metadata of the image in JSON format | What are you posting? What is in the mongo database about this image?Stored in Mongo(db: Camicroscope, collection: ImageData) |
Example of /ImageData
Need explanation of reason to use each item above.
...
POST
| Code Block |
|---|
$ curl -H "Content-Type: application/json" -X POST -d '{"case_id": "TCGA-01-0001", "width": 30000, "height": 31000}' http://localhost:9099/Camicroscope/ImageData/json
|
GET
| Code Block |
|---|
$ curl http://localhost:9099/Camicroscope/ImageData/fileLocation
|
...
/MarkupData
Bindaas
HTTP Verb | QueryEndpoint | Query Parameters(Input) | Output(Description) | Questions |
|---|---|---|---|---|
GET | /multipleMarkups | Case_id, x1,y1,x2,y2,footprint,algorithms | GeoJSON | Need explanation x1,y1,x2,y2 are different than what is in caMicroscope demo (had x, y, width, height) |
| N/A | /executionIds | case_id | List of execution IDs available for case | Need explanation. How would one get these execution IDs for a specific slide? Need to explain the difference between a caseID and an executionID–also any of the query modifiers. |
...
Examples of /uAIMTemplates
Examples here
/Tasks
Firebase/Kue???APIs for posting and retrieving tasks for caMicroscope. It uses Kue(https://github.com/Automattic/kue) to mantain all the tasks. It is well documented.
HTTP Verb | QueryEndpoint | Query Parameters(Input) | Output(Description) |
|---|---|---|---|
POST | /task | N/A | N/A |
| GET | task_id | N/A |
...
