Jump to

• Request
• Response

Get sites, depots and labs in a study by path attributes

get

/ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/sdfs/lov/{pathAttr}

Retrieves study sites, study depots and study labs by path attributes, as well as SDF type and status and includeRemoved flag. The supported path attributes are ID, name, studyOrgId, status, versionStart.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• pathAttr(required): string
  Column name.
• studyId(required): string(uuid)
  The ID of the study.

Query Parameters

• includeRemoved: boolean
  Includes removed study sites, study depots, study labs.
• sdfStatus(required): string
  Status of the site.
• sdfType(required): string
  Type of SDF : Sites or Depots.

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

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

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top