Jump to

• Request
• Response

v1.0

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.

  Example:

  8ECE2C9D389645B09740DC7926DEFB69

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  8ECE2C9D389645B09740DC7926DEFB69

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Label Group Response

Type: object

Title: Label Group Response

Contains label group response.

Show Source

• labelGroups: array Label Groups
  Title: Label Groups

  Contains label group detail.

{
    "title":"Label Group Response",
    "type":"object",
    "properties":{
        "labelGroups":{
            "title":"Label Groups",
            "type":"array",
            "description":"Contains label group detail.",
            "example":[
                {
                    "id":"8ECE2C9D389645B09740DC7926DEFB69",
                    "name":"US Labels",
                    "countries":[
                        {
                            "id":"B1B8327AFAA6412287106192AB5984EF",
                            "name":"United States"
                        }
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/LabelGroup"
            }
        }
    },
    "description":"Contains label group response."
}

Nested Schema : Label Groups

Type: array

Title: Label Groups

Contains label group detail.

Show Source

• Array of: object Label Group
  Title: Label Group

  Contains label group detail.

{
    "title":"Label Groups",
    "type":"array",
    "description":"Contains label group detail.",
    "example":[
        {
            "id":"8ECE2C9D389645B09740DC7926DEFB69",
            "name":"US Labels",
            "countries":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "name":"United States"
                }
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LabelGroup"
    }
}

Example:

[
    {
        "id":"8ECE2C9D389645B09740DC7926DEFB69",
        "name":"US Labels",
        "countries":[
            {
                "id":"B1B8327AFAA6412287106192AB5984EF",
                "name":"United States"
            }
        ]
    }
]

Nested Schema : Label Group

Type: object

Title: Label Group

Contains label group detail.

Show Source

• countries: array labelGroupGeographies
  Title: labelGroupGeographies

  Label group countries.
• id: string (uuid)
  ID of the label group.
• name: string
  Label group name.

  Example: Label1001

{
    "title":"Label Group",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Label group name.",
            "example":"Label1001"
        },
        "id":{
            "type":"string",
            "description":"ID of the label group.",
            "format":"uuid"
        },
        "countries":{
            "title":"labelGroupGeographies",
            "type":"array",
            "description":"Label group countries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "name":"United States"
                }
            ],
            "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 Label Group Geography
  Title: Label Group Geography

  Contains label group country detail.

{
    "title":"labelGroupGeographies",
    "type":"array",
    "description":"Label group countries.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "name":"United States"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LabelGroupGeography"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "name":"United States"
    }
]

Nested Schema : Label Group Geography

Type: object

Title: Label Group Geography

Contains label group country detail.

Show Source

• id: string (uuid)
  Unique ID for label country.
• name: string
  Label country.

  Example: India

{
    "title":"Label Group Geography",
    "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."
}

Examples

Select an example Label group

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

Examples

Select an example Get Label Group Forbidden Response

404 Response

Label group not found for study.

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

Examples

Select an example Get Label Group Not Found Response

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

Examples

Select an example Get Label Group Server Error Response

Back to Top