--- title: /v1/annotations/{uuid}/review/partial slug: beta-developer-docs/v1annotationsuuidreviewpartial docTags: createdAt: 2024-11-18T10:12:21.918Z --- { "id": "RE5up091GEHEUdAjEyTIx", "type": "api-oas-v2", "data": { "method": "POST", "url": "/v1/annotations/{uuid}/review/partial", "servers": [], "name": "", "description": "Start a review of an annotation with optional feedback", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "uuid", "type": "string", "description": "" } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "PartialReviewRequestDto", "schema": [ { "name": "feedbackItems", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/FeedbackItemIncomingDto", "customType": "FeedbackItemIncomingDto[]", "schema": [ { "name": "sensorId", "kind": "optional", "type": "string", "example": "" }, { "name": "frameId", "kind": "optional", "type": "string", "example": "" }, { "name": "objectId", "kind": "optional", "type": "string", "example": "" }, { "name": "pin", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PublicFeedbackMemberPinDto", "customType": "PublicFeedbackMemberPinDto", "schema": [ { "name": "x", "kind": "required", "type": "number", "example": "" }, { "name": "y", "kind": "required", "type": "number", "example": "" }, { "name": "z", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "suggestedProperty", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PublicFeedbackSuggestedPropertyDto", "customType": "PublicFeedbackSuggestedPropertyDto", "schema": [ { "name": "propertyName", "kind": "required", "type": "string", "example": "" }, { "name": "suggestedPropertyValue", "kind": "required", "type": "string", "example": "" } ] }, { "name": "errorTypeId", "kind": "required", "type": "string", "example": "" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Map_String", "customType": "Map_String", "schema": [] } ] } ], "modelRef": "#/components/schemas/PartialReviewRequestDto", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Enveloped_PartialReviewResponseDto", "schema": [ { "name": "data", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/PartialReviewResponseDto", "customType": "PartialReviewResponseDto", "schema": [ { "name": "createdReviewId", "kind": "optional", "type": "string", "example": "" } ] } ], "modelRef": "#/components/schemas/Enveloped_PartialReviewResponseDto", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "BadRequest", "schema": [ { "name": "message", "kind": "required", "type": "string", "example": "" }, { "name": "errorCode", "kind": "optional", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/BadRequest", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Unauthorized", "schema": [ { "name": "message", "kind": "required", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/Unauthorized", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Forbidden", "schema": [ { "name": "message", "kind": "required", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/Forbidden", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "NotFound", "schema": [ { "name": "message", "kind": "required", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/NotFound", "isExpanded": true } ] }, { "statusCode": "413", "description": "Payload too large", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "PayloadTooLarge", "schema": [ { "name": "message", "kind": "required", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/PayloadTooLarge", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "InternalServerError", "schema": [ { "name": "message", "kind": "required", "type": "string", "example": "" } ], "modelRef": "#/components/schemas/InternalServerError", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "6S9teATDMNPFKvxd_U0bT", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url /v1/annotations/{uuid}/review/partial \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"feedbackItems\": [\n {\n \"pin\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"suggestedProperty\": {\n \"propertyName\": \"\",\n \"suggestedPropertyValue\": \"\"\n },\n \"errorTypeId\": \"\"\n }\n ]\n }'" }, { "id": "wOed_pgMrDgf_i_5V02FU", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"feedbackItems\": [\n {\n \"pin\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"suggestedProperty\": {\n \"propertyName\": \"\",\n \"suggestedPropertyValue\": \"\"\n },\n \"errorTypeId\": \"\"\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"/v1/annotations/{uuid}/review/partial\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "1ZvqHrX5xSYZD1J2eDpSD", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/v1/annotations/{uuid}/review/partial\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"feedbackItems\": [\n {\n \"pin\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"suggestedProperty\": {\n \"propertyName\": \"\",\n \"suggestedPropertyValue\": \"\"\n },\n \"errorTypeId\": \"\"\n }\n ]\n})\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "kpXqA_H5OPPi-JVBrgRPo", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/v1/annotations/{uuid}/review/partial\"\n\npayload = json.dumps({\n \"feedbackItems\": [\n {\n \"pin\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"suggestedProperty\": {\n \"propertyName\": \"\",\n \"suggestedPropertyValue\": \"\"\n },\n \"errorTypeId\": \"\"\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "6S9teATDMNPFKvxd_U0bT" }, "results": { "languages": [ { "id": "BeDVHxXmhfSwlLPYhsqM2", "language": "200", "code": "{\n \"data\": {\n \"createdReviewId\": \"\"\n }\n}" }, { "id": "_EVW5mPMSqRj_fy9D4HxF", "language": "400", "code": "// Bad request\n{\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "SIwA_j6-1WwTvFPkHS4r3", "language": "401", "code": "// Unauthorized\n{\n \"message\": \"\"\n}" }, { "id": "0jacBkFFw9S29XSweB1cI", "language": "403", "code": "// Forbidden\n{\n \"message\": \"\"\n}" }, { "id": "RX8xIU4kNDKsD6FDfNnUF", "language": "404", "code": "// Not found\n{\n \"message\": \"\"\n}" }, { "id": "fO1eQfo42ZE8sCvEo9mNj", "language": "413", "code": "// Payload too large\n{\n \"message\": \"\"\n}" }, { "id": "-XSk2zplFhVkwYvs-Ul9H", "language": "500", "code": "// Internal server error\n{\n \"message\": \"\"\n}" } ], "selectedLanguageId": "BeDVHxXmhfSwlLPYhsqM2" } }, "children": [ { "id": "LX2irk7cq1Wr4QdTK1JGl", "type": "paragraph", "children": [ { "text": "Start a review of an annotation with optional feedback" } ] } ] }