REST API for Clinical One Cloud Service

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

mode(required): string
Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
Example:
```
test
```
studyId(required): string
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

Query Parameters

limit(required): integer(int32)
Minimum Value: 0

Maximum Value: 1000

Maximum number of rows to return. Only non-negative integers are accepted.
Example:
```
25
```
offset(required): integer(int32)
Minimum Value: 0

Zero-based row index to start pagination. Only non-negative integers are accepted.
Example:
```
0
```
siteId(required): string
Minimum Length: 1

Maximum Length: 255

Name search filter for site.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```
status(required): string
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.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : SDFsPaginatedResponse v2.0

Type: object

Title: SDFsPaginatedResponse v2.0

Paginated response wrapper used by CTMS/SDF endpoints.

Show Source

count: integer (int32)

Title: SDFsPaginatedResponse v2.0

Number of rows returned in this page.

Example: 25
hasMore: boolean

Title: SDFsPaginatedResponse v2.0

Flag indicating whether more pages of data are available.

Example: true
limit: integer (int32)

Title: SDFsPaginatedResponse v2.0

Maximum number of entries requested per page.

Example: 100
offset: integer (int32)

Title: SDFsPaginatedResponse v2.0

Pagination offset used to compute the returned subset.

Example: 0
resultData: object SDFsPaginatedResponse v2.0

Title: SDFsPaginatedResponse v2.0

Payload of the paginated response.
totalResults: integer (int32)

Title: SDFsPaginatedResponse v2.0

Total number of rows matching the paginated request.

Example: 250

{
    "title":"SDFsPaginatedResponse v2.0",
    "type":"object",
    "properties":{
        "hasMore":{
            "title":"SDFsPaginatedResponse v2.0",
            "type":"boolean",
            "description":"Flag indicating whether more pages of data are available.",
            "example":true
        },
        "totalResults":{
            "title":"SDFsPaginatedResponse v2.0",
            "type":"integer",
            "description":"Total number of rows matching the paginated request.",
            "format":"int32",
            "example":250
        },
        "count":{
            "title":"SDFsPaginatedResponse v2.0",
            "type":"integer",
            "description":"Number of rows returned in this page.",
            "format":"int32",
            "example":25
        },
        "limit":{
            "title":"SDFsPaginatedResponse v2.0",
            "type":"integer",
            "description":"Maximum number of entries requested per page.",
            "format":"int32",
            "example":100
        },
        "offset":{
            "title":"SDFsPaginatedResponse v2.0",
            "type":"integer",
            "description":"Pagination offset used to compute the returned subset.",
            "format":"int32",
            "example":0
        },
        "resultData":{
            "title":"SDFsPaginatedResponse v2.0",
            "type":"object",
            "description":"Payload of the paginated response.",
            "example":{
            }
        }
    },
    "description":"Paginated response wrapper used by CTMS/SDF endpoints."
}

Nested Schema : SDFsPaginatedResponse v2.0

Type: object

Title: SDFsPaginatedResponse v2.0

Payload of the paginated response.

Example:

{
}

Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

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

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples