REST API - Get Review Request
8 min
api/v1/projects/{projectId}/reviews/{artifactId}Description
Retrieves a review by Project ID and Artifact ID and returns information about the review.
URL Structure
[Blueprint_URI]/api/v1/projects/{ProjectId}/reviews/{ArtifactId}- ProjectId: The ID of the project that contains the review you want to retrieve.
- ArtifactId: The ID of the review artifact you want to retrieve.
Supported Methods
- HEAD
- GET
HTTP Status Codes
- 200: OK
- 201: Successfully Created
- 206: Partial Content
- 400: Bad Request This error can occur for a variety of reasons:
- At least one URI or request body parameter is invalid, such as one of the Filter, Traces, Offset or Limit parameters.
- A required value has not been provided.
- 401: Unauthorized
- The Blueprint token is missing, invalid or expired.
- 403: Forbidden
- The applicable permissions are needed. For example, this error can occur when:
- An Author or Collaborate license is needed for access.
- Comment permissions are needed on the artifact.
- Edit permissions are needed on the change summary job.
- 404: NotFound
- Item is not found in the project. For example, this error can occur when:
- Artifact not found.
- Artifact type not found.
- Project not found.
- ALM target not found.
- Change summary job not found.
- User does not have edit permissions for this artifact, project or ALM target.
- 409: Conflict
- Reason for failure can be found in the response body. Additional information may also be found in the log.
- 411: Length Required
- If the Content-Length header is missing in the request.
- 413: Request Entity Too Large
- If the provided file size is larger than allowed.
- 415: Unsupported Media Type
- If the provided media type is not of MIME Multipart Content "form-data."
- 416: Request Range Not Satisfiable
- If offset points to a part of a collection that is not available.
- 500: Internal Server Error
- 501: Not Implemented
Examples
XML Example
Request URI
http://production.blueprintcloud.com/api/v1/projects/3473663/reviews/3506415Response Body
<Review xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.blueprintsys.com/blueprint/api/v1"> <Id>3506415</Id> <Name>Milestone 1</Name> <ProjectId>3473663</ProjectId> <IsFormal>false</IsFormal> <ReviewStatus>Draft</ReviewStatus></Review>JSON Example
Request URI
https://production.blueprintcloud.com/api/v1/projects/3473663/reviews/3506415Response Body
{ "IsFormal": false, "ReviewStatus": "Draft", "Id": 3506415, "Name": "Milestone 1", "ProjectId": 3473663}