Jump to

• Request
• Response

Get global site property by property name

get

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties/{propName}

Retrieves the SDF global property with the specified property name.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• propName(required): string
  Get property of site by property name.
• studyId(required): string(uuid)
  The ID of the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : sdfPropertyList

Type: object

Title: sdfPropertyList

Contains site depot properties.

Show Source

• id: string (uuid)
  Unique id for site property
• propertyName: string
  Property name

  Example: drugDestruction
• propertyValue: string
  Property value

  Example: false
• reason: string
  reason

  Example: test
• sdfId: string (uuid)
  Unique id for site/depot
• versionStart: string (date-time)
  Version Start

{
    "title":"sdfPropertyList",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique id for site property",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Unique id for site/depot",
            "format":"uuid"
        },
        "propertyName":{
            "type":"string",
            "description":"Property name",
            "example":"drugDestruction"
        },
        "propertyValue":{
            "type":"string",
            "description":"Property value",
            "example":"false"
        },
        "reason":{
            "type":"string",
            "description":"reason",
            "example":"test"
        }
    },
    "description":"Contains site depot properties."
}

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