NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

file_location: Location of the image on file system

/uAIMDataLoader

Node application that converts Aperio and binary masks to GeoJSON objects and stores them in a Mongo database  

HTTP Verb

QueryEndpoint

Query Parameters(Input)

Output(Description)

POST

 /submitMaskOrder

Case_id,

Execution_id,

Height,

Width,

X,

Y,

Type(optional)

 {“jobId”: 12}

GET

/job/:id  None{“status”:”incomplete”}

Example of /uAIMDataLoader

Example curl cURL command (Aperio):

Code Block
$ curl localhost:6000/submitMaskOrder -F mask=@1.png -F case_id=cbtc_test_11 -F execution_id=ganesh:test2 -F width=1743 -F height=2017 -F x=0 -F y=0

Example curl cURL command (binary mask):

Code Block
$ curl localhost:6000/submitMaskOrder -F mask=@1.xml -F case_id=cbtc_test_11 -F execution_id=ganesh:test2 -F width=1743 -F height=2017 -F x=0 -F y=0 -F type= maskfile

...

HTTP Verb

QueryEndpoint

Query Parameters(Input)

Output(Description)Questions

GET

/fileLocation

case_id

Get file location of imageUsed by caMicroscope viewer to give the image location to it's its backend server
  /mpp case_id

Get mpp-x, mpp-y of the image

Used by the viewer to adjust the scales

  /metadata case_id

Get all metadata of the image(width, height, mpp etc.)

Used by dynamic services to get width, height and file location of image

  /md5 case_id

Get MD5 of the image file

Used to check the MD5 to make sure that the image was loaded successfully

POST/jsonmetdatametadata of the image in JSON formatStored in Mongo(db: Camicroscope, collection: ImageData)

Example of /ImageData

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

...

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.

...

Code Block
languagebash
titleExample of POSTing a task
$ curl -H "Content-Type: application/json" -X POST -d \
    '{
       "type": "order",
       "data": {
      
       },
       "options" : {
         "attempts": 5,
         "priority": "high"
       }
     }' http://localhost:3000/job
 

will output: 

  {"message": "job created", "id": 3}

This ID can be used to query the status of the job

...