Dicoogle Web Service API

This page will describe the latest web service API.

This page is currently incomplete. In order to have a more complete list of what operations can be made through Dicoogle's web services, please see the JavaScript client's API documentation here.

User Access / Profile

Login:

POST /accounts/login

• user
• pass

Logout:

POST /accounts/logout

User accounts, create, remove, etc.

CRUD /accounts/user

Access and Search

Search:

Search the DICOM metadata, perform queries on images.

GET /search

• keyword : Boolean
• query : String
• provider : String[]

Sample: ?query=StudyDate:[20141101 TO 20141103]
Expression Combination:
?query=StudyDate:[20141101 TO 20141103] AND Modality:CT

Result - JSON:

{ results: {uri: string, fields: object} }

Dump:

Perform a dump of a DICOM object's metadata.

GET /dump

• uid : String -- the DICOM object's identifier

Result - JSON: QIDO

WADO:

Obtain the full DICOM image.

GET /wado

• uid : String -- the DICOM object's identifier

Result - JSON: WADO

Export:

Export the query results to a particular format.

GET /export

• format : String -- one of the formats "CSV", "TSV"
• query : String -- the query text
• keyword : Boolean -- whether the query text is keyword based
• provider : String[] -- the query source providers to consider in the query

Providers:

Obtain the list of providers (plugins) installed in the system.

GET /providers

• type : String -- the type of providers, one of "query", "storage", "index" or "web services" (default is "query")
• enable : Boolean -- whether to only show enabled providers (default is true)

Examples: http://localhost:9000/search?query=antonio http://localhost:9000/image?SOPInstanceUID=1.2.392.200036.9116.4.1.5055.1166.7.3007.1.131017 http://localhost:9000/dump?SOPInstanceUID=1.2.392.200036.9116.4.1.5055.1166.7.3007.1.131017