/v1/reviews/{uuid}

1 min

GET

/v1/reviews/{uuid}

Fetch the review data by id

Path Parameters

uuidstring<uuid>required

Responses

200

Enveloped_ReviewDto
- dataReviewDtorequired
  - idstring<uuid>required
  - membersPublicFeedbackMemberDto[]
    - sensorIdstring
    - frameIdstring
    - objectIdstring
    - commentsstring[]
    - pinPublicFeedbackMemberPinDto
      - xnumber<double>required
      - ynumber<double>required
      - znumber<double>
    - descriptionstring
    - suggestedPropertiesPublicFeedbackSuggestedPropertyDto[]
      - propertyNamestringrequired
      - suggestedPropertyValuestringrequired
    - errorTypeIdstring<uuid>required
    - errorTypeNamestringrequired
    - invalidbooleanrequired
    - metadataMap_String
  - inputUuidstring<uuid>required
  - phaseIdstring<uuid>

400Bad request

BadRequest
- messagestringrequired
- errorCodestring

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

404Not found

NotFound
- messagestringrequired

413Payload too large

PayloadTooLarge
- messagestringrequired

500Internal server error

InternalServerError
- messagestringrequired

curl

curl --request GET \
     --url /v1/reviews/{uuid} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/v1/reviews/{uuid}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/v1/reviews/{uuid}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/v1/reviews/{uuid}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
  "data": {
    "id": "",
    "members": [
      {
        "sensorId": "",
        "frameId": "",
        "objectId": "",
        "comments": [
          ""
        ],
        "pin": {
          "x": "",
          "y": "",
          "z": ""
        },
        "description": "",
        "suggestedProperties": [
          {
            "propertyName": "",
            "suggestedPropertyValue": ""
          }
        ],
        "errorTypeId": "",
        "errorTypeName": "",
        "invalid": false,
        "metadata": {}
      }
    ],
    "inputUuid": "",
    "phaseId": ""
  }
}

400

// Bad request
{
  "message": "",
  "errorCode": ""
}

401

// Unauthorized
{
  "message": ""
}

403

// Forbidden
{
  "message": ""
}

404

// Not found
{
  "message": ""
}

413

// Payload too large
{
  "message": ""
}

500

// Internal server error
{
  "message": ""
}

Fetch the review data by id