REST API for Clinical One Platform

Update subject numbers

put

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/subjectnumber

Updates the subject(s) number with the specified value if it matches the predefined pattern.
Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.

Request

Path Parameters

mode(required): string

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

ID of the study to which the subject belongs.

Supported Media Types

application/json

Root Schema : SubjectNumbersRequestDto v1.0

Type: object

Title: SubjectNumbersRequestDto v1.0

Subject Number Request.

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Reason for change in subject number

Example: Wrong data entered.
reason(required): string

Minimum Length: 0

Maximum Length: 255

Others

Example: Wrong data entered.
subjects(required): array subjects

{
    "title":"SubjectNumbersRequestDto v1.0",
    "required":[
        "reason",
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectNumbersDtoV1"
            }
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Others",
            "example":"Wrong data entered."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Reason for change in subject number",
            "example":"Wrong data entered."
        }
    },
    "description":"Subject Number Request."
}

Nested Schema : subjects

Type: array

Show Source

Array of: object SubjectNumbersDto v1.0

Title: SubjectNumbersDto v1.0

Subject details for subject number changes.

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

Nested Schema : SubjectNumbersDto v1.0

Type: object

Title: SubjectNumbersDto v1.0

Subject details for subject number changes.

Show Source

newSubjectNumber(required): string

Minimum Length: 0

Maximum Length: 500

New subject number

Example: 10
objectVersionNumber(required): number

Current object version number

Example: 5
subjectId: string

Subject Id

Example: 3BF8356C6E4B49678D0609FF244DB4E3

{
    "title":"SubjectNumbersDto v1.0",
    "required":[
        "newSubjectNumber",
        "objectVersionNumber"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Subject Id",
            "example":"3BF8356C6E4B49678D0609FF244DB4E3"
        },
        "newSubjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"New subject number",
            "example":"10"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Current object version number",
            "example":5
        }
    },
    "description":"Subject details for subject number changes."
}

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object DcsResponse

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

Nested Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object