1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Site or Depot (SDF)
  5. SDF Management
  6. Create site or depot with study ID and master address

v1.0

post

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

Creates site or depot with study ID and master address for the specified tenant entity ID.

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
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : SDFDto v1.0
Type: object
Title: SDFDto v1.0
Metadata for a study site or depot.
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: SDF ID
    Unique identifier (UUID, 32-character uppercase hexadecimal string) of the SDF record.
  • Title: Name
    Minimum Length: 0
    Maximum Length: 200
    Official name of the site or depot.
    Example: Oakland Biomed Site
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: SDF Type
    Minimum Length: 0
    Maximum Length: 50
    Role of the SDF such as Site or Depot.
    Example: SITE
  • Title: Status
    Minimum Length: 0
    Maximum Length: 50
    Current status of the SDF, for example Active or Inactive.
    Example: ACTIVE
  • Title: Study Organization ID
    Minimum Length: 0
    Maximum Length: 50
    Identifier of the study organization linked to the SDF.
    Example: STUDY-123
Example:
{
    "id":"3F2504E04F8911D39A0C0305E82C3301",
    "name":"Oakland Biomed Site",
    "status":"ACTIVE",
    "sdfType":"SITE",
    "studyOrgId":"STUDY-123"
}
Nested Schema : sdfAddressAssociations
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfPropertyList
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFAddressAssociationDto
Type: object
Show Source
Nested Schema : sdfAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFsPropertyDto
Type: object
Show Source
Examples

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : SDFCreateUpdateResponse
Type: object
Show Source
Nested Schema : SDFDto v1.0
Type: object
Title: SDFDto v1.0
Metadata for a study site or depot.
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: SDF ID
    Unique identifier (UUID, 32-character uppercase hexadecimal string) of the SDF record.
  • Title: Name
    Minimum Length: 0
    Maximum Length: 200
    Official name of the site or depot.
    Example: Oakland Biomed Site
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: SDF Type
    Minimum Length: 0
    Maximum Length: 50
    Role of the SDF such as Site or Depot.
    Example: SITE
  • Title: Status
    Minimum Length: 0
    Maximum Length: 50
    Current status of the SDF, for example Active or Inactive.
    Example: ACTIVE
  • Title: Study Organization ID
    Minimum Length: 0
    Maximum Length: 50
    Identifier of the study organization linked to the SDF.
    Example: STUDY-123
Example:
{
    "id":"3F2504E04F8911D39A0C0305E82C3301",
    "name":"Oakland Biomed Site",
    "status":"ACTIVE",
    "sdfType":"SITE",
    "studyOrgId":"STUDY-123"
}
Nested Schema : sdfAddressAssociations
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : sdfPropertyList
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFAddressAssociationDto
Type: object
Show Source
Nested Schema : sdfAddressProperties
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : SDFsPropertyDto
Type: object
Show Source
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