REST API for Clinical One Cloud Service

v1.0

get

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/countries

Retrieves all countries where sites or depots are created by SDF type.

Request

Path Parameters

mode(required): string
Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
Example:
```
test
```
sdfType(required): string
SDF type filter. Allowed values: site/SITE (site records), depot/DEPOT (depot records), lab/LAB (lab records), all/ALL (all supported SDF types).
Example:
```
site
```
studyId(required): string
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

Query Parameters

mainPrimary(required): boolean
Boolean flag. true returns only main-primary country addresses; false returns all matching addresses.

Default Value: false

Allowed Values: [ true, false ]
Example:
```
false
```

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 Country

Title: Country

Country entity metadata.

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

Nested Schema : Country

Type: object

Title: Country

Country entity metadata.

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Additional user comment about the latest change.

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

Title: Country Id

Pattern: ^[A-F0-9]{32}$

Unique country identifier.
isoCode(required): string

Title: ISO Code

Minimum Length: 1

Maximum Length: 10

ISO alpha-2 country code.

Example: US
isoCode3(required): string

Title: ISO Code3

Minimum Length: 1

Maximum Length: 10

ISO alpha-3 country code.

Example: USA
name(required): string

Title: Country Name

Minimum Length: 1

Maximum Length: 100

Country display name.

Example: United States
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for the latest change made to this record.

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

Title: Version Start

Version start timestamp.

Example: 2025-03-16T12:00:00Z

{
    "title":"Country",
    "required":[
        "id",
        "isoCode",
        "isoCode3",
        "name",
        "versionStart"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the latest change made to this record.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional user comment about the latest change.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"Country Id",
            "pattern":"^[A-F0-9]{32}$",
            "type":"string",
            "description":"Unique country identifier.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time",
            "example":"2025-03-16T12:00:00Z"
        },
        "isoCode":{
            "title":"ISO Code",
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"ISO alpha-2 country code.",
            "example":"US"
        },
        "name":{
            "title":"Country Name",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"Country display name.",
            "example":"United States"
        },
        "isoCode3":{
            "title":"ISO Code3",
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"ISO alpha-3 country code.",
            "example":"USA"
        }
    },
    "description":"Country entity metadata."
}

Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

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