Worklist API: create draft documentation which describes endpoints and workflow to retrieve and edit items

Worklists API Interface

Get all worklists for specified group

curl -X GET "http://orthanc:8842/sonador/studies/worklists/<group-id>"  \
   -H "Authorization: Bearer h:X"

Create new worklists object for Study

curl -X POST "http://orthanc:8842/sonador/studies/<orthanc-study-id>/worklists"  \
   -H "Authorization: Bearer h:X" \
   -H "Content-Type: application/json" \
   -d '{"group": "1", "status": "Rejected", "Text": "Rejected This Study"}'

Edit an existing worklist item

curl -X PUT "http://orthanc:8842/sonador/studies/<orthanc-study-id>/worklists/<worklist-object-id>" \  
   -H "Authorization: Bearer h:x" \
   -H "Content-Type: application/json" \
   -d '{"group": "1", "status": "Approved", "Text": "Rejected This Study Because I Felt Like It", "User": 
"1"}'

Delete an existing worklist item

curl -X DELETE "http://orthanc:8842/sonador/studies/<orthanc-study-id>/worklists/<worklist-object-id>" \  
   -H "Authorization: Bearer h:x"

POST / PUT JSON format remains the same of

• '{"group": "{group-id}", "status": "['Rejected' | 'Approved' | 'Unread' | 'Reviewed']"}'
• ex: '{"group": "1", "status": "Unread"}'