REST API for Clinical One Platform

Update source data verification group

put

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup

Updates a source data verification group with unique name and values for keys (initial subjects count, remaining subject percentage, initial subjects sdf type and remaining subject sdf type).

Request

Path Parameters

mode(required): string

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

The ID of the study.

Supported Media Types

Root Schema : schema

Type: object

Show Source

sdvGroupKeyValPairs: array sdvGroupKeyValPairs
sdvGroupNewName: string

Minimum Length: 0

Maximum Length: 255
sdvGroupOldName(required): string

Minimum Length: 0

Maximum Length: 255

{
    "required":[
        "sdvGroupOldName"
    ],
    "type":"object",
    "properties":{
        "sdvGroupOldName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "sdvGroupNewName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "sdvGroupKeyValPairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDVGroupKeyValDto"
            }
        }
    }
}

Nested Schema : sdvGroupKeyValPairs

Type: array

Show Source

Array of: object SDVGroupKeyValDto

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

Nested Schema : SDVGroupKeyValDto

Type: object

Show Source

attributeKey(required): string

Minimum Length: 0

Maximum Length: 255
attributeValue(required): string

Minimum Length: 0

Maximum Length: 255

{
    "required":[
        "attributeKey",
        "attributeValue"
    ],
    "type":"object",
    "properties":{
        "attributeKey":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "attributeValue":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object signVerifyRequest

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

Nested Schema : signVerifyRequest

Type: object

Show Source

sdvGroupId: string
sdvGroupKeyValPairs: array sdvGroupKeyValPairs
sdvGroupName(required): string

Minimum Length: 0

Maximum Length: 255

{
    "required":[
        "sdvGroupName"
    ],
    "type":"object",
    "properties":{
        "sdvGroupName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "sdvGroupId":{
            "type":"string"
        },
        "sdvGroupKeyValPairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDVGroupKeyValDto"
            }
        }
    },
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : sdvGroupKeyValPairs

Type: array

Show Source

Array of: object SDVGroupKeyValDto

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

Nested Schema : SDVGroupKeyValDto

Type: object

Show Source

attributeKey(required): string

Minimum Length: 0

Maximum Length: 255
attributeValue(required): string

Minimum Length: 0

Maximum Length: 255

{
    "required":[
        "attributeKey",
        "attributeValue"
    ],
    "type":"object",
    "properties":{
        "attributeKey":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "attributeValue":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        }
    }
}

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