1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Labs
  5. Get all labs associated with a given site

v3.0

get

/ec-site-svc/rest/v3.0/studies/{studyId}/{mode}/labs

Compared with v2, this version adds lab status filtering and status-aware response data.

Request

Path Parameters
  • Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
    Example:
    test
  • Study identifier as a 32-character uppercase hexadecimal UUID string.
    Example:
    C36A3197FDEE433FB5547EE83DE99E4B
Query Parameters
  • Minimum Value: 0
    Maximum Value: 1000
    Maximum number of rows to return. Only non-negative integers are accepted.
    Example:
    25
  • Minimum Value: 0
    Zero-based row index to start pagination. Only non-negative integers are accepted.
    Example:
    0
  • Minimum Length: 1
    Maximum Length: 255
    Name search filter for site.
    Example:
    Site-A
  • Lab status filter. Allowed values: ACTIVE (available), NEW (newly created), RESTRICTED (limited use), DISBARRED (blocked), DECEASED (closed), RETIRED (inactive).
    Allowed Values: [ "New", "Active", "Retired", "ACTIVE", "NEW", "RESTRICTED", "DISBARRED", "DECEASED", "RETIRED" ]
    Example:
    ACTIVE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : LabResponse
Type: object
Show Source
Nested Schema : labAddresses
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : LabDetailsDto
Type: object
Show Source
Example:
{
    "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
    "labId":"B1B8327AFAA6412287106192AB5984EF",
    "labStatus":"ACTIVE"
}
Nested Schema : labProperties
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"
    }
]
Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.
Body ()
Root Schema : LabResponse
Type: object
Show Source
Nested Schema : labAddresses
Type: array
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : LabDetailsDto
Type: object
Show Source
Example:
{
    "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
    "labId":"B1B8327AFAA6412287106192AB5984EF",
    "labStatus":"ACTIVE"
}
Nested Schema : labProperties
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"
    }
]
Examples

Back to Top