Skip to content

Sample Package List

GEThttps://${domain}/rosetta-open/sampling/samplePackageList

We will provide a GET API for query the list of sample packages.

query params

*campaignIdstring Defaults to 7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b
Unique identifier for the campaign, with a maximum length of 255 bytes.
*offsetnumber Defaults to 1
The page number for pagination, starting from 1.
*limitnumber Defaults to 10
The number of records per page, a positive integer, the maximum is 100.
Examples
shell
curl https://${domain}/rosetta-open/sampling/samplePackageList?campaignId=7d44b43b-3bbd-4f53-9f95-b7c0217d8d5b&offset=1&limit=10 \
 -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": {
"count": 7,
"data": [...]
},
"date": "2025-05-26 11:42:50",
"requestId": "704c602c8bb84971bf0a5f8fbb11718a",
"success": true
}
5000
{
"code": 5000,
"data": null,
"message": "Service hiccuped, please try again later.",
"date": "2025-03-13 20:00:00",
"requestId": "864b70706a7349ea83e177a49800464f",
"success": false
}

response body field description

field namedescription
samplePackageIdPrimary key ID generated by the created sample package.
poolIdSampling pool ID
poolNameSampling pool name
createdTimeThe time for creating the sample package.
campaignIdCampaign ID
statusCurrent sample package status (0: completed 1: sampling)
subConditionSampling conditions
interceptionModeInterception method value, Please see the enumeration values defined below. They are not intercepted by default
interceptionFrameRequired when your interceptionMode parameter is not sequence length
interceptionBoundaryRequired when your interceptionMode type is custom
realTimeInfoThe usage of the objects

subCondition field description

field namedescription
currentPoolIdCurrent sampling pool ID
poolIdWork pool ID list
flowTypeTask flow type (1: Previous pool 2: Historical pool)
screenTypeFilter logic type (and / or)
needMarkWhether annotation is not required
haveIssueWhether has quality issues
rejectNumberNumber of rejections (0-3)
datasetIdDataset ID list
taskIdTask ID list
startTimePool entry start time
endTimePool entry end time
folderIdListFolder ID list

interceptionBoundary field description

field namedescription
startStart position
endEnd position

interceptionMode enum

keyvalue
1random continuity
2positive
3reversed
4system random
5custom
6sequence length

realTimeInfo field description

field namedescription
keyUnique ID of object
value[0]object number
value[1]Total number of slots