REST API for Clinical One Platform

~~[Deprecated]: Get data elements for a visit and form combination~~

get

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements

Deprecated: Filters and retrieves data elements for form data in an event. This supports the start date for Integration Hub. If a start date is provided, it returns the snaphsot of data elements just before start date. In the case when the current query parameter is set to true, this will return the latest data.

Request

Path Parameters

formId(required): string

Form ID from Designer.
mode(required): string

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

Subject ID.

Query Parameters

current(required): boolean

If set to true, it returns the current data. Else, it returns the data just before the visit is complete.
eventId(required): string

Visit ID from Designer.
startDate(required): string(date-time)

The date for which you want to retrieve the data values.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataElementDto20

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

Nested Schema : DataElementDto20

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dateTimeValueUTC: string (date-time)
dayValue: integer
eventId: string
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"
        }
    }
}

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