Skip to content

Mapping Review endpoints

tudorgroza edited this page Feb 22, 2021 · 1 revision

TOC

CREATE

  • Endpoint: POST /v1/projects/{projectId}/mappings/{mappingId}/reviews
  • Role required: ADMIN or CONTRIBUTOR
  • Payload: <STRING> comment (Optional)
  • Response (Review):
201 | CREATED

{
  "comment": "STRING",
  "created": {
    "user": {
      "name": "Test User 1",
      "email": "[email protected]"
    },
    "timestamp": "2021-02-11T21:23:14.156+08:00"
  }
}

OR

404 | NOT FOUND
  • If projectId is inexistent or user doesn't have access to it

RETRIEVE ALL

  • Endpoint: /v1/projects/{projectId}/mappings/{mappingId}/reviews
  • Response (List of Review):
200 | OK

[{
  "comment": "STRING",
  "created": {
    "user": {
      "name": "Test User 1",
      "email": "[email protected]"
    },
    "timestamp": "2021-02-11T21:23:14.156+08:00"
  }
},
...
]

OR

404 | NOT FOUND
  • If projectId is inexistent or user doesn't have access to it