1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Site or Depot (SDF)
  5. SDF Management
  6. Get all sites and depots details by study ID based on given filters

v1.0

get

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

Retrieves site or depot details for a study using filter parameters. If sdfType is ALL, both sites and depots are returned; if SITE or DEPOT, only that type is returned.

Request

Path Parameters
  • Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
    Example:
    test
  • 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
  • Study identifier as a 32-character uppercase hexadecimal UUID string.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
Query Parameters
  • Minimum Length: 2
    Maximum Length: 1024
    Pattern: ^([A-Z]{2})(,[A-Z]{2})*$
    Comma-separated list of ISO alpha-2 country codes.
    Example:
    US
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[A-F0-9]{32}$
    Country identifier as a 32-character uppercase hexadecimal UUID string.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
  • Retrieve extended properties for site only if the excludeExtendedProperties flag is false.
    Allowed Values: [ "true", "false" ]
    Example:
    false
  • Minimum Value: 0
    Maximum Value: 1000
    Maximum number of rows to return. Only non-negative integers are accepted.
    Example:
    50
  • Minimum Length: 1
    Maximum Length: 255
    Name search filter for site.
    Example:
    Site A
  • Minimum Value: 0
    Zero-based row index to start pagination. Only non-negative integers are accepted.
    Example:
    0
  • Optional query parameter. Sort direction for returned rows. Allowed values: asc, desc, ASC, DESC.
    Allowed Values: [ "ASC", "DESC", "asc", "desc" ]
    Example:
    DESC
  • SDF status filter. Allowed values: ACTIVE (available), NEW (newly created), RESTRICTED (limited use), DISBARRED (blocked), DECEASED (closed), RETIRED (inactive).
    Allowed Values: [ "ACTIVE", "NEW", "RESTRICTED", "DISBARRED", "DECEASED", "RETIRED" ]
    Example:
    ACTIVE
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[0-9]+$
    Study version filter for sites or depots. Accepts non-negative integer version numbers.
    Example:
    1
  • Minimum Length: 32
    Maximum Length: 32
    Pattern: ^[A-F0-9]{32}$
    Supply Country ID.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : SDFDetailsResponse
Type: object
Show Source
Nested Schema : Discriminator: sdfType
Type: object
Show Source
Example:
{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "tenantEntityId":"B1B8327AFAA6412287106192AB5984EF",
    "statusId":"B1B8327AFAA6412287106192AB5984EF",
    "sdfType":"Site"
}
Nested Schema : sdfAddressAssociations
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfKitSettingDto
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfPropertyList
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFAddressAssociationDetailsDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : entityAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFPropertyDetailsDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFKitSettingDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.
Body ()
Root Schema : SDFDetailsResponse
Type: object
Show Source
Nested Schema : Discriminator: sdfType
Type: object
Show Source
Example:
{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "tenantEntityId":"B1B8327AFAA6412287106192AB5984EF",
    "statusId":"B1B8327AFAA6412287106192AB5984EF",
    "sdfType":"Site"
}
Nested Schema : sdfAddressAssociations
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfKitSettingDto
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfPropertyList
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFAddressAssociationDetailsDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : entityAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFPropertyDetailsDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFKitSettingDto
Type: object
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Examples

Back to Top