REST API for Clinical One Platform

Get label groups

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups

Retrieves label groups by study ID. Rights: OrsInventoryGet and OrsUnblinded.

Request

Path Parameters

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.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object LabelGroup

Contains label group detail.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LabelGroup"
    }
}

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 name

Example: Label1001

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Label group name",
            "example":"Label1001"
        },
        "id":{
            "type":"string",
            "description":"Unique Id for label group.",
            "format":"uuid"
        },
        "countries":{
            "title":"labelGroupGeographies",
            "type":"array",
            "description":"Label group countries.",
            "items":{
                "$ref":"#/components/schemas/LabelGroupGeography"
            }
        }
    },
    "description":"Contains label group detail."
}

Nested Schema : labelGroupGeographies

Type: array

Title: labelGroupGeographies

Label group countries.

Show Source

Array of: object LabelGroupGeography

Contains label group country detail

{
    "title":"labelGroupGeographies",
    "type":"array",
    "description":"Label group countries.",
    "items":{
        "$ref":"#/components/schemas/LabelGroupGeography"
    }
}

Nested Schema : LabelGroupGeography

Type: object

Contains label group country detail

Show Source

id: string (uuid)

Unique Id for label country.
name: string

Label country

Example: India

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Id for label country.",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Label country",
            "example":"India"
        }
    },
    "description":"Contains label group country detail"
}

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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object