Jump to

• Request
• Response

v1.0

get

/ec-site-svc/rest/v1.0/studies/{studyId}/site/{mode}/{sdfId}

Retrieves study-site details, including study version properties, for the specified site ID.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• sdfId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for a site, depot, or lab (SDF).

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyId(required): string(uuid)
  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

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudySiteLiteResponse

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

Nested Schema : StudySiteLiteResponse

Type: object

Show Source

• sdfPropertyList: array sdfPropertyList
• site: object SiteDetailsLiteDto

{
    "type":"object",
    "properties":{
        "site":{
            "$ref":"#/components/schemas/SiteDetailsLiteDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFPropertyDetailsDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SiteDetailsLiteDto

Type: object

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
• institutionId: string (uuid)
• institutionName: string
  Example: City Hospital
• objectVersionNumber: number
  Title: Object Version Number

  Internal object version number captured for optimistic locking.

  Example: 1
• oldSdfId: string (uuid)
• operationType: string
  Title: Operation Type

  Minimum Length: 1

  Maximum Length: 16

  Operation applied to the record. Allowed values: CREATED (record was added), MODIFIED (record was updated), REMOVED (record was logically removed).

  Example: MODIFIED
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• softwareVersionNumber: number
  Title: Software Version Number

  Software version number captured when the record was updated.

  Example: 1
• statusId: string (uuid)
• statusIdCodeValue: string
  Example: ACTIVE
• studyOrgIdName: string
  Example: Primary Site Org
• tenantEntityId: string (uuid)
• userId: string (uuid)
  Title: User ID

  Identifier of the user who performed the audited action.
• versionEnd: string (date-time)
  Title: Version End

  Timestamp when the version ended.

  Example: 2026-03-30T12:00:00Z
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Timestamp when the version ended.",
            "format":"date-time",
            "example":"2026-03-30T12:00:00Z"
        },
        "operationType":{
            "title":"Operation Type",
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation applied to the record. Allowed values: CREATED (record was added), MODIFIED (record was updated), REMOVED (record was logically removed).",
            "example":"MODIFIED"
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"Identifier of the user who performed the audited action.",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Internal object version number captured for optimistic locking.",
            "example":1
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number captured when the record was updated.",
            "example":1
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "studyOrgIdName":{
            "type":"string",
            "example":"Primary Site Org"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "statusIdCodeValue":{
            "type":"string",
            "example":"ACTIVE"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "institutionId":{
            "type":"string",
            "format":"uuid"
        },
        "institutionName":{
            "type":"string",
            "example":"City Hospital"
        }
    },
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "tenantEntityId":"B1B8327AFAA6412287106192AB5984EF",
        "statusId":"B1B8327AFAA6412287106192AB5984EF",
        "oldSdfId":"B1B8327AFAA6412287106192AB5984EF"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "tenantEntityId":"B1B8327AFAA6412287106192AB5984EF",
    "statusId":"B1B8327AFAA6412287106192AB5984EF",
    "oldSdfId":"B1B8327AFAA6412287106192AB5984EF"
}

Nested Schema : SDFPropertyDetailsDto

Type: object

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
• objectVersionNumber: number
  Title: Object Version Number

  Internal object version number captured for optimistic locking.

  Example: 1
• operationType: string
  Title: Operation Type

  Minimum Length: 1

  Maximum Length: 16

  Operation applied to the record. Allowed values: CREATED (record was added), MODIFIED (record was updated), REMOVED (record was logically removed).

  Example: MODIFIED
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Example: Sample Name
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 1024

  Example: sample
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
• softwareVersionNumber: number
  Title: Software Version Number

  Software version number captured when the record was updated.

  Example: 1
• userId: string (uuid)
  Title: User ID

  Identifier of the user who performed the audited action.
• versionEnd: string (date-time)
  Title: Version End

  Timestamp when the version ended.

  Example: 2026-03-30T12:00:00Z
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Timestamp when the version ended.",
            "format":"date-time",
            "example":"2026-03-30T12:00:00Z"
        },
        "operationType":{
            "title":"Operation Type",
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation applied to the record. Allowed values: CREATED (record was added), MODIFIED (record was updated), REMOVED (record was logically removed).",
            "example":"MODIFIED"
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"Identifier of the user who performed the audited action.",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Internal object version number captured for optimistic locking.",
            "example":1
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number captured when the record was updated.",
            "example":1
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "example":"Sample Name"
        },
        "propertyValue":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "example":"sample"
        }
    },
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Select an example Success Response

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

• 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

Select an example Bad Request Response

Back to Top