All calls should be preceded by /v2, for example http:epad.stanford.edu:8080/epad/v2/projects/
POST | /session/ |
Create a session using HTTP Basic Authentication (username and password Base64 encoded in header). Don't use /v2 for this call.
Parameters
|
||||||
DELETE | /session/:session |
Delete a session by passing the session identifier. Don't use /v2 for this call. |
GET | /projects/ |
Get all projects.
Parameters
|
|||||||||||||||
GET | /projects/:project |
Get this project.
Parameters
|
|||||||||||||||
PUT | /projects/:project |
Update an existing project.
Parameters
|
|||||||||||||||
DELETE | /projects/:project |
Delete the project. | |||||||||||||||
POST | /projects/:project |
Create a new project.
Parameters
|
GET | /users |
Get users. | |||||||||||||||||||||
GET | /users/:user |
Get a user. User is user ID or email. | |||||||||||||||||||||
POST | /users/:user |
Create a user.
Input
firstname=first&lastname=last&email=first.last@gmail.com&password=pw&type=new
|
|||||||||||||||||||||
PUT | /users/:user |
Modify user. All parameters are optional, old password is required only when modifying current password, old password is not required if an admin is logged in.
Parameters
|
|||||||||||||||||||||
DELETE | /users/:user |
Delete user. | |||||||||||||||||||||
PUT | /users/:user/sendnewpassword/ |
Generate a new password and send it to the user's email. | |||||||||||||||||||||
GET | /projects/:project/users/ |
Get the project's users. | |||||||||||||||||||||
PUT | /projects/:project/users/:user |
Modify the user in the project.
Parameters
|
|||||||||||||||||||||
DELETE | /projects/:project/users/:user |
Remove a user from the project. |
GET | /users/:user/groups/ |
Get groups for user. |
PUT | /users/:user/groups/:group |
Create group for user. |
DELETE | /users/:user/groups/:group |
Remove group for user. |
GET | /subjects/ |
Get the subjects. | ||||||||||||
GET | /subjects/:subject |
Get the subject. | ||||||||||||
GET | /projects/:project/subjects/ |
Get the project's subjects.
Parameters
|
||||||||||||
GET | /projects/:project/subjects/:subject |
Get a subject in the project.
Parameters
|
||||||||||||
PUT | /projects/:project/subjects/:subject |
Create or modify a subject in the project.
Parameters
|
||||||||||||
PUT | /projects/:project/subjects/:subject/status/:status |
Set status of the subject. | ||||||||||||
DELETE | /projects/:project/subjects/:subject |
Remove a subject from a project.
Parameters
|
||||||||||||
PUT | /users/:user/worklists/:worklist/subjects/:subject |
Add subject to a worklist. | ||||||||||||
POST | /users/:user/worklists/:worklist/subjects/ |
Add subjects to a worklist.
Input
{ "Subjects": [ "7", "LIDC-IDRI-0314", "AAA 20120823", "AMA 62139" ] }
|
GET | /projects/:project/subjects/:subject/studies/ |
Get the studies.
Parameters
|
||||||||||||
PUT | /projects/:project/subjects/:subject/studies/:study |
Add a study to the project.
Parameters
|
||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study |
Get a study.
Parameters
|
||||||||||||
DELETE | /projects/:project/subjects/:subject/studies/:study |
Remove a study from a project.
Parameters
|
||||||||||||
GET | /pacs/:pac/subjects/:subject/studies/ |
Get studies for a subject in a connection.
Parameters
|
||||||||||||
GET | /users/:user/worklists/:worklist/studies/ |
Get studies in a worklist. | ||||||||||||
GET | /users/:user/worklists/:worklist/subjects/:subject/studies/ |
Get studies in a worklist. | ||||||||||||
GET | /users/:user/worklists/:worklist/subjects/ |
Get subjects for worklist. | ||||||||||||
PUT | /users/:user/worklists/:worklist/subjects/:subject |
Modify subject status.
Parameters
|
||||||||||||
PUT | /users/:user/worklists/:worklist/subjects/:subject/studies/:study |
Add or modify study in a worklist.
Parameters
|
GET | /studies/:study/series |
Get the series collection. | ||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/ |
Get the series collection.
Parameters
|
||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series |
Get the series.
Parameters
|
||||||||||||
PUT | /projects/:project/subjects/:subject/studies/:study/series/:series |
Create a non-dicom series or update series annotation status
Parameters
|
||||||||||||
DELETE | /projects/:project/subjects/:subject/studies/:study/series/:series |
Delete a series.
Parameters
|
||||||||||||
GET | /pacs/:pacs/subjects/:subject/studies/:study/series/ |
Get list of series for this study and subject in connection. |
GET | /wado/ |
get the WADO instance. (Note /v2 is not required in URL)
Parameters
|
||||||||||||||||||
GET | /studies/:study/series/:series/images/:image |
Get the image. | ||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/ |
get the images in the series | ||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image |
Get an image in the collection. | ||||||||||||||||||
DELETE | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image |
Delete an image. | ||||||||||||||||||
GET | /projects/:project/subjects/:subject |
Download images for this subject to zip file.
Parameters
|
||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study |
Get images for this study in a zip file.
Parameters
|
||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:stud/series/:series |
Download images for this series in a zip file. Parameters
|
GET | /studies/:study/series/:series/images/:image/frames |
Get the frames. | |||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/frames |
Get the frames.
Parameters
|
|||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/frames/:frameNumber |
Get the frame.
Parameters
|
|||||||||
POST | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/frames |
Edit a DICOM SEG series, multiple part request, json edit request followed by mask files. | |||||||||
POST | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/frames |
Create a new DICOM SEG series, multiple part request, json edit request followed by mask files. SeriesUID is series of the source dicom.
Parameters
|
|||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/frames/:frame |
Get the frame. |
GET | /aims/ |
Get the annotations.
Parameters
|
||||||||||||||||||||||||
GET | /aims/:aim |
Get the annotation.
Parameters
|
||||||||||||||||||||||||
GET | /aims/:aim |
Get json data for this annotation and plugin. Parameters
|
||||||||||||||||||||||||
PUT | /aims/:aim |
Undo OR Redo last change in the annotation. Parameters
|
||||||||||||||||||||||||
PUT | /aims/:aim |
Set color for the annotation. Parameters
|
||||||||||||||||||||||||
DELETE | /aims/:aim |
Delete the annotation.
Parameters
|
||||||||||||||||||||||||
GET | /subjects/:subject/aims/ |
Get the annotations for the subject.
Parameters
|
||||||||||||||||||||||||
GET | /projects/:project/aims/ |
Get the annotations for the project.
Parameters
|
||||||||||||||||||||||||
GET | /projects/:project/aims/:aim |
Get the annotation for the project.
Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/aims/ |
Run the specified plugin template on the annotation IDs.
Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/aims/:aim |
Create a new annotation. | ||||||||||||||||||||||||
GET | /projects/:project/subjects/:subject/aims/ |
Get the annotations for the subject in the project.
Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/subjects/:subject/aims/:aim |
Create an annotation in a project for a subject. | ||||||||||||||||||||||||
GET | /studies/:study/series/:series/images/:image/aims/ |
Get the annotations for the image.
Parameters
|
||||||||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/aims/ |
Get the annotations.
Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/subjects/:subject/studies/:study/aims/:aim |
Create a new annotation. | ||||||||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/aims/ |
Get the annotations. If no format is specified, the xml annotation will be returned. Include Study Aims if parameter is set to true. Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/subjects/:subject/studies/:study/series/:series/aims/:aim |
Create an annotation in the series. | ||||||||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/aims/ |
get the annotations IDs for the image. Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/aims/:aim |
create an annotation for the image | ||||||||||||||||||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/images/:image/frames/:frame/aims/ |
get the annotations for the frame. If no format is specified, the xml annotation will be returned. Parameters
|
||||||||||||||||||||||||
GET | /users/:user/reviewees/:reviewee/aims/ |
Get annotations for reviewee. |
GET | /resourcesFile |
Get files under the resource folder, Note /v2 is not required in URL.
Parameters
|
|||||||||
GET | /projects/:project/files/ |
Get non-DICOM files for this project.
Parameters
|
|||||||||
GET | /projects/:project/files/:file |
Get a non-DICOM file for this project. Parameters
|
|||||||||
GET | /projects/:project/subjects/:subject/files/ |
Get non-DICOM files for this project and subject. Parameters
|
|||||||||
GET | /projects/:project/subjects/:subject/studies/:study/files/ |
get non-DICOM files for this project, subject and study. Parameters
|
|||||||||
GET | /projects/:project/subjects/:subject/studies/:study/series/:series/files/ |
Get non-DICOM files for this project, subject, study and series. Parameters
|
|||||||||
POST | /projects/{id}/files/?fileType=[Template | Annotation | Image]&description={value} | Upload files for this project | |||||||||
POST | /projects/{id}/subject/{id}/files/ | Upload files for this project and subject | |||||||||
POST | /projects/{id}/subject/{id}/studies/{id}/files/ | Upload files for this project, subject and study | |||||||||
POST | /projects/{id}/subject/{id}/studies/{id}/series/{id}/files/ | Upload files for this project, subject, study and series | |||||||||
PUT | /projects/{id}/files/{filename}?name={value}&description={value}&fileType={type} | Change name, description, type for a file (all parameters are optional) | |||||||||
DELETE | /projects/{id}/files/{name} | delete a non-DICOM file in this project | |||||||||
DELETE | /projects/{id}/subjects/{id}/files/{name} | delete a non-DICOM file for this subject | |||||||||
DELETE | /projects/{id}/subjects/{id}/studies/{id}/files/{name} | delete a non-DICOM file for this study | |||||||||
DELETE | /projects/{id}/subjects/{id}/studies/{id}/series/{id}/files/{name} | delete a non-DICOM file for this series |
GET | /templates/ |
Get templates. | |||||||||
PUT | /templates/ |
Upload template. Template will be validated against schema. | |||||||||
POST | /templates/ |
Upload template. Template will be validated against schema. | |||||||||
GET | /projects/:project/files/ |
Get the templates for this project.
Parameters
|
|||||||||
POST | /projects/:project/files/ |
Upload a new template for this project, xml will be validated.
Parameters
|
|||||||||
PUT | /projects/:project/templates/:templatecode |
enable/disable templates
Parameters
|
|||||||||
PUT | /templates/:templatecode |
Enable or disable template.
Parameters
|
|||||||||
DELETE | /templates/:templatecode |
Delete template. |
GET | /plugins/ |
Get tools. Parameters
|
||||||||||||||||||||||||
PUT | /plugins/:plugin |
Create tool. Parameters
|
||||||||||||||||||||||||
DELETE | /plugins/:plugin | Delete tool. | ||||||||||||||||||||||||
GET | /projects/:project/plugins/ |
Get tools for this project. Parameters
|
||||||||||||||||||||||||
PUT | /projects/:project/plugins/:plugin |
Enable or disable tools for this project. Parameters
|
||||||||||||||||||||||||
GET | /projects/:project/plugins/:plugin/parameters/ |
Get tool parameters for this project. | ||||||||||||||||||||||||
PUT | /projects/:project/plugins/:plugin/parameters/ |
Set tool parameters for this project. Parameters
|
GET | /pacs/ |
Get connections. | |||||||||||||||
GET | /pacs/:pacs |
Get connection. | |||||||||||||||
DELETE | /pacs/:pacs |
Delete connection. | |||||||||||||||
PUT | /pacs/:pacs |
Modify or create connection.
Parameters
|
|||||||||||||||
GET | /pacs/:pacs/entities/ |
get list of studies/series/images in this Remote PAC. Formats for date filter - on: '20071001', from/to: '20071001-20080220', before: '-20080220', after: '20071001-' . If series= true, return series records as well as studies. Parameters
|
|||||||||||||||
GET | /pacs/{id}/entities/?tagGroup={value}&tagElement={value}&tagValue={value}&tagType=[LongString | ShortString | Date | Time | Integer | Decimal | Code] | get list of studies/series/images in this Remote PAC, filter by specified DICOM tag. The tagType parameter is optional (defaults to LongString). Unfortunately if the tag is not supported for query by the PAC, all records are returned. Example query by Body Part Tag: /pacs/epad-build/entities/?tagGroup=0x0018&tagElement=0x0015&tagValue=CHEST&tagType=ShortString | |||||||||||||||
GET | /pacs/{id}/subjects/?patientNameFilter={value}&patientIDFilter={value} | get list of subjects in this Remote PAC. | |||||||||||||||
GET | /pacs/:pacs/entities/:entity |
Transfer this data (and all its children) from this Remote PAC to ePAD's dcm4chee and into this project. Parameters
|
|||||||||||||||
GET | /pacs/getFromTCIA/ |
Download series from TCIA and add it to a project.
Parameters
|
GET | /pacs/:pacs/autoqueries/ |
List of configured automatic queries for this Remote PAC | |||||||||||||||
GET | /pacs/:pacs/autoqueries/:autoquery |
get configured automatic query for this Remote PAC and this subject | |||||||||||||||
PUT | /pacs/:pacs/autoqueries/:autoquery |
configure an automatic query for this Remote PAC and this subject. projectID is required, the other parameters are optional.
Parameters
|
|||||||||||||||
PUT | /pacs/:pacs/autoqueries/:autoquery |
enable/disable automatic query for this Remote PAC and this subject.
Parameters
|
|||||||||||||||
DELETE | /pacs/:pacs/autoqueries/:autoquery |
Delete query for this connection and this subject. | |||||||||||||||
GET | /pacs/dicomtags/ |
Get a list of dicom tags. |
GET | /queries/ |
Get queries. | ||||||||||||||||||
PUT | /queries/ |
Create a query.
Parameters
|
||||||||||||||||||
GET | /queries/:query |
Get this query. | ||||||||||||||||||
DELETE | /queries/:query |
Delete the query. | ||||||||||||||||||
PUT | /queries/:query |
Modify a query.
Parameters
|
GET | /users/:user/worklists/ |
Get the worklists. | ||||||||||||
GET | /users/:user/worklists/:worklist |
Get the worklist. | ||||||||||||
DELETE | /users/:user/worklists/:worklist |
Delete the worklist. | ||||||||||||
PUT | /users/:user/worklists/:worklist |
Create a worklist.
Parameters
|
||||||||||||
PUT | /users/:user/worklists/:worklist |
Modify the worklist.
Parameters
|
GET | /users/:user/eventlogs/ |
Get a log of user actions.
Parameters
|
GET | /users/:user/taskstatus/ |
Get status of executing tasks. |
GET | /epad/status |
Get the status of the installation. (/v2 not required) |
GET | /epad/imagecheck |
Get the status of images. (/v2 not required) |
GET | /epad/imagecheck/?seriesUID=:seriesUID |
Trigger png generating on a specific series. (/v2 not required) |
GET | /epad/dsoresave/?projectID=:projectID&seriesUID=:seriesUID&aimID=:aimID |
Resave the DSO to fix the old DSOs with DICOM tag issues. SeriesUID or aimID is enough (/v2 not required) |
GET | /epad/dsoresave/?projectID=:projectID&nameContains=:nameContains |
Resave the DSO to fix the old DSOs with DICOM tag issues. It will filter the aims with the name containing :nameContains and resave them (/v2 not required) |
GET | /epads/stats/ |
Get ePAD hosts.
Parameters
|
|||||||||||||||
GET | /epads/ |
Get ePAD hosts.
Parameters
|
|||||||||||||||
GET | /epads/:epad |
Get usage statistics for the host. | |||||||||||||||
GET | /epads/version/ |
Get ePAD version. | |||||||||||||||
GET | /epads/version/ |
Download current ePAD version.
Parameters
|