Get kits from all study versions in Testing, Approved and Archived
get
/ec-designer-svc/rest/v3.0/studies/{studyId}/kits
Retrieves list of kits for all study versions in Testing, Approved and Archived states.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
-
mode(required): string
Study mode to filter kits.Allowed Values:
[ "test", "training", "active" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object KitDescDto V3.0
Title:
KitDescDto V3.0Kit description and distribution setting
Nested Schema : KitDescDto V3.0
Type:
objectTitle:
KitDescDto V3.0Kit description and distribution setting
Show Source
-
deviceConn: string
Device ConnectionExample:
D2C -
deviceType: string
Device TypeExample:
SCALE -
distributionSetting: string
(string)
Distribution SettingExample:
UNBLINDED -
kitDescription: string
(string)
Kit descriptionExample:
Kit_1003_1 -
kitId: string
(uuid)
Kit Unique GUID
-
kitType: string
(string)
Kit Type IDExample:
Kit_1003_1 -
trialSupplyType: string
Trial Supply TypeExample:
BOTTLE
500 Response
Error
Root Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource