Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top