REST API for Clinical One Platform

Freeze multiple data elements for a subject

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze

Freezes multiple data elements for a subject based on the data element ID. Rights: DataCaptureSubjectIntegrationGet and SubjectDataClassificationGet.

Request

Path Parameters

mode(required): string

Mode to fetch the record for
studyId(required): string

ID of the study for which you want to get the list of subjects.

Supported Media Types

Root Schema : schema

Type: object

Show Source

elements: array elements
eventId: string
eventInstanceNum: integer
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "elements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreSignVerifyRequestDto"
            }
        }
    },
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : elements

Type: array

Show Source

Array of: object CoreSignVerifyRequestDto

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

Nested Schema : CoreSignVerifyRequestDto

Type: object

Show Source

eventInstanceNumber: integer
formId: string
formSectionId: string
innerRepeat: integer
itemId: string
outerRepeat: integer
repeatFormNumber: integer
repeatSequenceNumber: integer

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "eventInstanceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataElementDto30

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

Nested Schema : DataElementDto30

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dateTimeValueUTC: string (date-time)
dayValue: integer
eventId: string
eventInstanceNum: integer
floatValue: number
formId: string
formSectionId: string
hourValue: integer
id: string (uuid)
itemId: string
measureUnit: string

Minimum Length: 0

Maximum Length: 64
minuteValue: integer
monthValue: integer
normalizedUnitId: string
normalizedValue: string

Minimum Length: 0

Maximum Length: 100
numValue: integer
objectVersionNumber: number
originatorId: string
reason: string

Minimum Length: 0

Maximum Length: 255
repeatSequenceNumber: integer
secondValue: integer
siteId: string
studyId: string
studyName: string

Minimum Length: 0

Maximum Length: 100
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
transactionEnd: string (date-time)
transactionStart: string (date-time)
userId: string (uuid)
validationFailure: string

Minimum Length: 0

Maximum Length: 32767
validationStatus: string

Minimum Length: 0

Maximum Length: 25
value: string

Minimum Length: 0

Maximum Length: 4000
variableId: string
vendorCode: string

Minimum Length: 0

Maximum Length: 100
versionStart: string (date-time)
yearValue: integer

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "maxLength":"25",
            "minLength":"0",
            "type":"string"
        },
        "validationFailure":{
            "maxLength":"32767",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "studyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "value":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "measureUnit":{
            "maxLength":"64",
            "minLength":"0",
            "type":"string"
        },
        "normalizedValue":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "normalizedUnitId":{
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "dateTimeValueUTC":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "eventInstanceNum":{
            "type":"integer"
        }
    }
}

400 Response

Bad request.

Root Schema : RestResponse

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