Skip to content

[WIP] Get Annotation Request

GEThttps://${domain}/rosetta-open/annotation-request

Guidelines for retrieving an annotation request on Rosetta.

WARNING

The fields 'successSchedule' and 'errorSchedule' are not included in the response of the current version.

query params

*annotationRequestIdstring Defaults to 7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b
Unique identifier for the annotation request, with a maximum length of 160 bytes.
Examples
shell
curl https://${domain}/rosetta-open/annotation-request?annotationRequestId=7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b \
 -X GET \
 -H 'Content-Type: application/json' \
 -H 'X-STARDUST-KEY: <X-STARDUST-KEY>' \
 -H 'X-TS: <X-TS>' \
 -H 'X-SIGN: <X-SIGN>'

responses

2000
{
"code": 2000,
"message": "Success",
"data": {
"status": "FINISHED",
"successTaskMap": {...},
"errorSceneIdMap": {...},
"successSchedule": 33.33,
"errorSchedule": 66.67
},
"date": "2024-05-16 19:03:34",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": true
}
5000
{
"code": 5000,
"data": null,
"message": "Service hiccuped, please try again later.",
"date": "2024-05-16 19:03:34",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}

Status Enum

ValueDescription
ID_NOT_EXISTSAnnotation request does not exist
PROCESSINGAnnotation task is in progress
FINISHEDAnnotation task has been completed
FAILEDAn error occurred in the annotation task