REST API for Clinical One Cloud Service

v1.0

get

/ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/properties/piname

Retrieves full name of a principal investigator for all accessible sites in a study.

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(uuid)
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

Query Parameters

sdfStatus: string
SDF status filter. Allowed values: ACTIVE (available), NEW (newly created), RESTRICTED (limited use), DISBARRED (blocked), DECEASED (closed), RETIRED (inactive).
Example:
```
ACTIVE
```
sdfType: string
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
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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