REST API for Clinical One Platform

Update site/depot with study ID and master address

put

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}

Updates site/depot with study ID and master address for the specified tenant entity ID.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts active, test, or training.
sdfId(required): string

Type of SDF : Sites or Depots.
sdfType(required): string

Type of SDF : Sites or Depots.
studyId(required): string(uuid)

The ID of the study.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

sdf: object SDFDto
sdfAddressAssociations: array sdfAddressAssociations
sdfPropertyList: array sdfPropertyList

{
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        },
        "sdfAddressAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDto"
            }
        }
    }
}

Nested Schema : SDFDto

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
name(required): string

Minimum Length: 0

Maximum Length: 200
reason: string

Minimum Length: 0

Maximum Length: 255
sdfType(required): string

Minimum Length: 0

Maximum Length: 50
status(required): string

Minimum Length: 0

Maximum Length: 50
studyOrgId(required): string

Minimum Length: 0

Maximum Length: 50
versionStart: string (date-time)

{
    "required":[
        "name",
        "sdfType",
        "status",
        "studyOrgId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "name":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string"
        },
        "status":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "sdfType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "studyOrgId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        }
    }
}

Nested Schema : sdfAddressAssociations

Type: array

Show Source

Array of: object SDFAddressAssociationDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFAddressAssociationDto"
    }
}

Nested Schema : sdfPropertyList

Type: array

Show Source

Array of: object SDFsPropertyDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Nested Schema : SDFAddressAssociationDto

Type: object

Show Source

addressTypeId: string (uuid)
addressTypeIdCodeValue: string

Minimum Length: 0

Maximum Length: 50
comment: string

Minimum Length: 0

Maximum Length: 2048
entityAddressAssociationId(required): string (uuid)
id: string (uuid)
mainPrimary: boolean
reason: string

Minimum Length: 0

Maximum Length: 255
sdfAddressProperties: array sdfAddressProperties
sdfId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        },
        "mainPrimary":{
            "type":"boolean"
        }
    }
}

Nested Schema : sdfAddressProperties

Type: array

Show Source

Array of: object SDFsPropertyDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Nested Schema : SDFsPropertyDto

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
propertyName(required): string

Minimum Length: 0

Maximum Length: 100
propertyValue(required): string

Minimum Length: 0

Maximum Length: 2048
reason: string

Minimum Length: 0

Maximum Length: 255
sdfId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "propertyValue":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: object

Show Source

sdf: object SDFDto
sdfAddressAssociations: array sdfAddressAssociations
sdfPropertyList: array sdfPropertyList

{
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        },
        "sdfAddressAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDto"
            }
        }
    }
}

Nested Schema : SDFDto

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
name(required): string

Minimum Length: 0

Maximum Length: 200
reason: string

Minimum Length: 0

Maximum Length: 255
sdfType(required): string

Minimum Length: 0

Maximum Length: 50
status(required): string

Minimum Length: 0

Maximum Length: 50
studyOrgId(required): string

Minimum Length: 0

Maximum Length: 50
versionStart: string (date-time)

{
    "required":[
        "name",
        "sdfType",
        "status",
        "studyOrgId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "name":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string"
        },
        "status":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "sdfType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "studyOrgId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        }
    }
}

Nested Schema : sdfAddressAssociations

Type: array

Show Source

Array of: object SDFAddressAssociationDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFAddressAssociationDto"
    }
}

Nested Schema : sdfPropertyList

Type: array

Show Source

Array of: object SDFsPropertyDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Nested Schema : SDFAddressAssociationDto

Type: object

Show Source

addressTypeId: string (uuid)
addressTypeIdCodeValue: string

Minimum Length: 0

Maximum Length: 50
comment: string

Minimum Length: 0

Maximum Length: 2048
entityAddressAssociationId(required): string (uuid)
id: string (uuid)
mainPrimary: boolean
reason: string

Minimum Length: 0

Maximum Length: 255
sdfAddressProperties: array sdfAddressProperties
sdfId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        },
        "mainPrimary":{
            "type":"boolean"
        }
    }
}

Nested Schema : sdfAddressProperties

Type: array

Show Source

Array of: object SDFsPropertyDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Nested Schema : SDFsPropertyDto

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
propertyName(required): string

Minimum Length: 0

Maximum Length: 100
propertyValue(required): string

Minimum Length: 0

Maximum Length: 2048
reason: string

Minimum Length: 0

Maximum Length: 255
sdfId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "propertyValue":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        }
    }
}

400 Response

Bad request.

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