REST API for Clinical One Cloud Service

~~[Deprecated]: v1.0~~

get

/ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}

Deprecated: Retrieves details of a region by region ID. The region includes a list of associated countries.

Request

Path Parameters

mode(required): string
Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
Example:
```
test
```
regionId(required): string
Id for the required region
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```
studyId(required): string(uuid)
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : RegionDto v1.0

Type: object

Title: RegionDto v1.0

Region metadata that lists associated countries.

Show Source

comment: string

Title: Comment

Minimum Length: 0

Maximum Length: 2048

Additional comment captured for the audited update.

Example: Association adjusted after data reconciliation.
id: string (uuid)

Title: Region ID

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region.
name(required): string

Title: Region Name

Minimum Length: 1

Maximum Length: 100

Official name of the region.

Example: North America Region
reason: string

Title: Reason

Minimum Length: 0

Maximum Length: 255

Reason provided for the audited update.

Example: Protocol update requested by study operations.
regionCountries(required): object RegionCountryDto v1.0

Title: RegionCountryDto v1.0

Country metadata captured for each region.
versionStart: string (date-time)

Title: Version Start

Timestamp when this region version was created.

Example: 2026-03-17T10:00:00Z

{
    "title":"RegionDto v1.0",
    "required":[
        "name",
        "regionCountries"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"Region ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this region version was created.",
            "format":"date-time",
            "example":"2026-03-17T10:00:00Z"
        },
        "name":{
            "title":"Region Name",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"Official name of the region.",
            "example":"North America Region"
        },
        "regionCountries":{
            "title":"RegionCountryDto v1.0",
            "required":[
                "countryId"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "id":{
                    "title":"Region Country ID",
                    "type":"string",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.",
                    "format":"uuid"
                },
                "versionStart":{
                    "title":"Version Start",
                    "type":"string",
                    "description":"Timestamp when this region-country association version was created.",
                    "format":"date-time",
                    "example":"2026-03-17T10:00:00Z"
                },
                "countryId":{
                    "title":"Country ID",
                    "type":"string",
                    "description":"Identifier of the country linked to the region.",
                    "format":"uuid"
                },
                "countryName":{
                    "title":"Country Name",
                    "type":"string",
                    "description":"Display name of the country associated with the region.",
                    "example":"United States"
                }
            },
            "description":"Country metadata captured for each region.",
            "example":[
                {
                    "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
                    "countryName":"United States"
                }
            ]
        }
    },
    "description":"Region metadata that lists associated countries.",
    "example":[
        {
            "id":"A0E1B2C3D4E5F67890123456789ABCDE",
            "name":"North America Region"
        }
    ]
}

Example:

[
    {
        "id":"A0E1B2C3D4E5F67890123456789ABCDE",
        "name":"North America Region"
    }
]

Nested Schema : RegionCountryDto v1.0

Type: object

Title: RegionCountryDto v1.0

Country metadata captured for each region.

Show Source

comment: string

Title: Comment

Minimum Length: 0

Maximum Length: 2048

Additional comment captured for the audited update.

Example: Association adjusted after data reconciliation.
countryId(required): string (uuid)

Title: Country ID

Identifier of the country linked to the region.
countryName: string

Title: Country Name

Display name of the country associated with the region.

Example: United States
id: string (uuid)

Title: Region Country ID

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.
reason: string

Title: Reason

Minimum Length: 0

Maximum Length: 255

Reason provided for the audited update.

Example: Protocol update requested by study operations.
versionStart: string (date-time)

Title: Version Start

Timestamp when this region-country association version was created.

Example: 2026-03-17T10:00:00Z

{
    "title":"RegionCountryDto v1.0",
    "required":[
        "countryId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"Region Country ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this region-country association version was created.",
            "format":"date-time",
            "example":"2026-03-17T10:00:00Z"
        },
        "countryId":{
            "title":"Country ID",
            "type":"string",
            "description":"Identifier of the country linked to the region.",
            "format":"uuid"
        },
        "countryName":{
            "title":"Country Name",
            "type":"string",
            "description":"Display name of the country associated with the region.",
            "example":"United States"
        }
    },
    "description":"Country metadata captured for each region.",
    "example":[
        {
            "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
            "countryName":"United States"
        }
    ]
}

Example:

[
    {
        "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
        "countryName":"United States"
    }
]

Examples

400 Response

Bad Request

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

errorData: object ErrorResponseData
result: object result

The result object for successful requests. Type depends on the API operation.
status: string

Status of the response, either 'success' or an error indication.

Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

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

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples