Skip to content

Get comments about a study

gerome12 edited this page Nov 9, 2018 · 4 revisions

Used to get comments (private and public) about a study. For getting comments, the user must have minimum one series.

URL : /studies/{StudyInstanceUID}/comments

Method : GET

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim. The user must be am admin or an user with "comments" permission.

Headers

  • Accept : If present, require that this value be application/json

URL Parameters

  • limit={limit} (Optional)
  • offset={offset} (Optional)

Success Response

  • Status : 200 OK

Comments are sorted by descending date.

[
    {
        "event_type": "Comment",
        "origin_name": "[email protected]",
        "comment": "second comment",
        "post_date": "2018-09-23T06:59:01",
        "is_private": true,
        "target_name": "[email protected]"
    },
    {
        "event_type": "Comment",
        "origin_name": "[email protected]",
        "comment": "first comment",
        "post_date": "2018-09-21T06:59:02",
        "is_private": false
    },
    {...}
]

The response is a JSON array of comments.
Comments can be : private or public.
Public comment :

{
    "event_type": "Comment",
    "origin_name": "[email protected]",
    "comment": "first comment",
    "post_date": "2018-09-21T06:59:02",
    "is_private": false
}

Private comment :

{
    "event_type": "Comment",
    "origin_name": "[email protected]",
    "comment": "second comment",
    "post_date": "2018-09-23T06:59:01",
    "is_private": true,
    "target_name": "[email protected]"
}

Error Response

If the user is not found.
If the study is not found.

  • Status : 404 Not Found
Clone this wiki locally