Get label groups by ID
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Retrieves label groups by label group ID. Rights: OrsInventoryGet and OrsUnblinded.
Request
Path Parameters
-
id(required): string(uuid)
ID of the label group
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : LabelGroupResponse
Type:
object
Contains label group response.
Show Source
-
labelGroups: array
labelGroups
Title:
labelGroups
Contains label group detail.
Nested Schema : labelGroups
Type:
array
Title:
labelGroups
Contains label group detail.
Show Source
-
Array of:
object LabelGroup
Contains label group detail.
Nested Schema : LabelGroup
Type:
object
Contains label group detail.
Show Source
-
countries: array
labelGroupGeographies
Title:
labelGroupGeographies
Label group countries. -
id: string
(uuid)
Unique Id for label group.
-
name: string
Label group nameExample:
Label1001
Nested Schema : labelGroupGeographies
Type:
array
Title:
labelGroupGeographies
Label group countries.
Show Source
-
Array of:
object LabelGroupGeography
Contains label group country detail
Nested Schema : LabelGroupGeography
Type:
object
Contains label group country detail
Show Source
-
id: string
(uuid)
Unique Id for label country.
-
name: string
Label countryExample:
India
403 Response
The study identifier does not match any study identifiers in Clinical One.
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
Label group not found for study.
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object