REST API for Clinical One Platform

Update subject settings

put

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings

Updates a list of subject settings. Rights: SubjectSettingRightsPost.

Request

Path Parameters

mode(required): string

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

ID of the study for which you want to get/update/delete subject settings.

Supported Media Types

Root Schema : schema

Type: object

Show Source

subjectSettings: array subjectSettings

{
    "type":"object",
    "properties":{
        "subjectSettings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectSettingDto"
            }
        }
    }
}

Nested Schema : subjectSettings

Type: array

Show Source

Array of: object SubjectSettingDto

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

Nested Schema : SubjectSettingDto

Type: object

Show Source

attributeKey(required): string
attributeValue(required): string
comment: string

Minimum Length: 0

Maximum Length: 2048
id: string (uuid)
objectVersionNumber: number
reason: string

Minimum Length: 0

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

{
    "required":[
        "attributeKey",
        "attributeValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "attributeKey":{
            "type":"string"
        },
        "attributeValue":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "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

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "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