1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Region
  5. Get list of regions with history

v2.0

get

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

Compared with v1, this version returns regions with both country and state associations.

Request

Path Parameters
  • Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
    Example:
    test
  • Study identifier as a 32-character uppercase hexadecimal UUID string.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : RegionsResponse v2.0
Type: object
Title: RegionsResponse v2.0
Response wrapping the region list returned by v2 APIs.
Show Source
Nested Schema : RegionStatesDto v2.0
Type: object
Title: RegionStatesDto v2.0
Region metadata that lists country and state associations.
Show Source
Example:
[
    {
        "id":"A0E1B2C3D4E5F67890123456789ABCDE",
        "name":"North America Region",
        "regionCountriesStates":[
            {
                "countryId":"C0D1E2F3A4B567890123456789ABCDEF",
                "stateId":"B0C1D2E3F4A567890123456789ABCDEF",
                "stateName":"California"
            }
        ]
    }
]
Nested Schema : RegionCountryStatesDto v2.0
Type: object
Title: RegionCountryStatesDto v2.0
Country and state metadata returned for a region.
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: Country ID
    Identifier of the country linked to the region.
  • Title: Country Name
    Display name of the country associated with the region.
    Example: United States
  • Title: Region Country ID
    Unique identifier (UUID, 32-character uppercase hexadecimal string) of the region-country association.
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: State ID
    Identifier of the state associated with the country.
  • Title: State Name
    Name of the state associated with the region.
    Example: California
  • Title: Version Start
    Timestamp when this region-country association version was created.
    Example: 2026-03-17T10:00:00Z
Example:
[
    {
        "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
        "stateId":"B0C1D2E3F4A567890123456789ABCDEF",
        "stateName":"California"
    }
]
Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.
Body ()
Root Schema : SDFResponse
Type: object
Title: SDFResponse
Wrapper for service responses containing result or error data.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
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

403 Response

Returned when the caller is authenticated but does not have permission to access this endpoint.
Body ()
Root Schema : SDFResponse
Type: object
Title: SDFResponse
Wrapper for service responses containing result or error data.
Show Source
Nested Schema : ErrorResponseData
Type: object
Show Source
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

Back to Top