REST API for Clinical One Platform

Migrate a subject

post

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

Migrates a subject adding it to a study using subject migration API with sourceTimeStamp value.
This API has been built without any validations:

API expects the Subject Number provided as part of payload to match exactly the Subject Number settings.
API also expect sourceTimeStamp value as part of payload.
It ignores the Subject Number Settings and creates the Subject with Subject Number provided as part of payload.
Caller needs to ensure it provides Site Prefix, hyphen, leading zeros and any pattern defined as part of Subject Number Settings.

Rights: MigrationDataPost.

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 the list of subjects.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

subject: object SubjectMigrationRequestDTO

{
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectMigrationRequestDTO"
        }
    }
}

Nested Schema : SubjectMigrationRequestDTO

Type: object

Show Source

siteId: string (uuid)
sourceTimeStamp: string (date-time)
state(required): string

Minimum Length: 0

Maximum Length: 100
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500

{
    "required":[
        "state",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

400 Response

Bad request.

Root Schema : SubjectMigrationResponseDTO

Type: object

Show Source

codeBreak: string
comment: string

Minimum Length: 0

Maximum Length: 2048
description: string

Minimum Length: 0

Maximum Length: 500
dob: string (date-time)
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255
eventType: string
gender: string

Minimum Length: 0

Maximum Length: 10
id: string (uuid)
informedConsentDate: string (date-time)
objectVersionNumber: number
reason: string

Minimum Length: 0

Maximum Length: 255
screeningDate: string (date-time)
screeningFailure: string

Minimum Length: 0

Maximum Length: 255
siteId: string
sourceTimeStamp: string (date-time)
state(required): string

Minimum Length: 0

Maximum Length: 100
stateDate: string (date-time)
studyId: string
studyVersion(required): string
subjectNumber(required): string

Minimum Length: 0

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

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "eventType":{
            "type":"string"
        },
        "subjectTransferId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}