1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Site or Depot (SDF)
  5. SDF Management
  6. Get site or depot details by SDF ID and SDF Type

v2.0

get

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

Compared with v1, this endpoint supports audit-history retrieval by SDF ID and SDF type.

Request

Path Parameters
  • Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
    Example:
    test
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) for a site, depot, or lab (SDF).
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
  • 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
  • Optional comma-separated attribute list to include in the response. Allowed values: INFO, PROPERTIES, ADDRESSES, KITSETTINGS.
  • Retrieve extended properties for site only if the excludeExtendedProperties flag is false.
  • Boolean flag: true includes historical records, false returns only current records.

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 : 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