[Deprecated]: Get Visits MetaData which is part of ODMSubmit
get
/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}
Deprecated: Returns all visits metadata for the specified subject.Rights: DataCaptureSubjectGet and SubjectDataClassificationGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/odmsubmit/visitsMetadata/{subjectId}
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts test, active, or training.
-
studyId(required): string
ID of the study to which the subject belongs.
-
subjectId(required): string(uuid)
ID of the subject for whom you want to retrieve history.
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Subjects success.
Nested Schema : ODM
Type:
Show Source
object
-
AdminData: array
AdminData
-
Archival: string
Allowed Values:
[ "YES" ]
-
AsOfDateTime: string
-
Association: array
Association
-
ClinicalData: array
ClinicalData
-
CreationDateTime: string
-
Description: string
-
FileOID: string
-
FileType: string
Allowed Values:
[ "Snapshot", "Transactional" ]
-
Granularity: string
Allowed Values:
[ "Metadata", "AdminData", "ReferenceData", "AllClinicalData", "SingleSite", "SingleSubject" ]
-
ID: string
-
ODMVersion: string
-
Originator: string
-
PriorFileOID: string
-
ReferenceData: array
ReferenceData
-
Signature: array
Signature
-
SourceSystem: string
-
SourceSystemVersion: string
-
Study: array
Study
Nested Schema : Location
Type:
Show Source
object
-
locationType: string
Allowed Values:
[ "SPONSOR", "SITE", "CRO", "LAB", "OTHER" ]
-
metaDataVersionRef(required): array
MetaDataVersionRef
-
name: string
-
oid: string
Nested Schema : SignatureDef
Type:
Show Source
object
-
legalReason(required): object
LegalReason
-
meaning(required): object
Meaning
-
methodology: string
Allowed Values:
[ "DIGITAL", "ELECTRONIC" ]
-
oid: string
Nested Schema : User
Type:
Show Source
object
-
address: array
Address
-
certificate: array
Certificate
-
displayName: object
DisplayName
-
email: array
Email
-
fax: array
Fax
-
firstName: object
FirstName
-
fullName: object
FullName
-
lastName: object
LastName
-
locationRef: array
LocationRef
-
loginName: object
LoginName
-
oid: string
-
organization: object
Organization
-
pager: object
Pager
-
phone: array
Phone
-
picture: object
Picture
-
userType: string
Allowed Values:
[ "SPONSOR", "INVESTIGATOR", "LAB", "OTHER" ]
Nested Schema : items
Type:
object
Nested Schema : Annotation
Type:
Show Source
object
-
comment: object
Comment
-
flag: array
Flag
-
id: string
-
seqNum: integer
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
Nested Schema : Comment
Type:
Show Source
object
-
sponsorOrSite: string
Allowed Values:
[ "SPONSOR", "SITE" ]
-
value: string
Nested Schema : AuditRecord
Type:
Show Source
object
-
dateTimeStamp(required): object
DateTimeStamp
-
editPoint: string
Allowed Values:
[ "MONITORING", "DATA_MANAGEMENT", "DB_AUDIT" ]
-
id: string
-
locationRef(required): object
LocationRef
-
reasonForChange: object
ReasonForChange
-
sourceID: object
SourceID
-
usedImputationMethod: string
Allowed Values:
[ "YES", "NO" ]
-
userRef(required): object
UserRef
Nested Schema : SubjectData
Type:
Show Source
object
-
annotation: array
Annotation
-
auditRecord: object
AuditRecord
-
investigatorRef: object
InvestigatorRef
-
signature: object
Signature
-
siteRef: object
SiteRef
-
studyEventData: array
studyEventData
-
subjectKey: string
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
Nested Schema : StudyEventData
Type:
Show Source
object
-
annotation: array
Annotation
-
auditRecord: object
AuditRecord
-
formData: array
formData
-
signature: object
Signature
-
studyEventOID: string
-
studyEventRepeatKey: string
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
Nested Schema : FormData
Type:
Show Source
object
-
annotation: array
Annotation
-
archiveLayoutRef: object
ArchiveLayoutRef
-
auditRecord: object
AuditRecord
-
formOID: string
-
formRepeatKey: string
-
itemGroupData: array
itemGroupData
-
signature: object
Signature
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
Nested Schema : ItemGroupData
Type:
Show Source
object
-
annotation: array
Annotation
-
auditRecord: object
AuditRecord
-
itemDataGroup: array
itemDataGroup
-
itemDataStarGroup: array
itemDataStarGroup
-
itemGroupOID: string
-
itemGroupRepeatKey: string
-
signature: object
Signature
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
Nested Schema : ItemData
Type:
Show Source
object
-
annotation: array
Annotation
-
auditRecord: object
AuditRecord
-
isNull: string
Allowed Values:
[ "YES" ]
-
itemOID: string
-
measurementUnitRef: object
MeasurementUnitRef
-
signature: object
Signature
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
-
value: string
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
object
Nested Schema : MetaDataVersion
Type:
Show Source
object
-
codeList: array
CodeList
-
conditionDef: array
ConditionDef
-
description: string
-
formDef: array
formDef
-
imputationMethod: array
ImputationMethod
-
include: object
Include
-
itemDef: array
itemDef
-
itemGroupDef: array
itemGroupDef
-
methodDef: array
MethodDef
-
name: string
-
oid: string
-
presentation: array
Presentation
-
protocol: object
Protocol
-
studyEventDef: array
studyEventDef
Nested Schema : CodeList
Type:
Show Source
object
-
alias: array
Alias
-
codeListItem: array
codeListItem
-
dataType: string
Allowed Values:
[ "INTEGER", "FLOAT", "TEXT", "STRING" ]
-
description: object
Description
-
enumeratedItem: array
EnumeratedItem
-
externalCodeList: object
ExternalCodeList
-
name: string
-
oid: string
-
sasformatName: string
Nested Schema : FormDef
Type:
Show Source
object
-
alias: array
Alias
-
archiveLayout: array
ArchiveLayout
-
description: object
Description
-
itemGroupRef: array
ItemGroupRef
-
name: string
-
oid: string
-
repeating: string
Allowed Values:
[ "YES", "NO" ]
Nested Schema : ItemGroupRef
Type:
Show Source
object
-
collectionExceptionConditionOID: string
-
itemGroupOID: string
-
mandatory: string
Allowed Values:
[ "YES", "NO" ]
-
orderNumber: integer
Nested Schema : ItemDef
Type:
Show Source
object
-
alias: array
Alias
-
codeListRef: object
CodeListRef
-
comment: string
-
dataType: string
Allowed Values:
[ "INTEGER", "FLOAT", "DATE", "DATETIME", "TIME", "TEXT", "STRING", "DOUBLE", "URI", "BOOLEAN", "HEX_BINARY", "BASE_64_BINARY", "HEX_FLOAT", "BASE_64_FLOAT", "PARTIAL_DATE", "PARTIAL_TIME", "PARTIAL_DATETIME", "DURATION_DATETIME", "INTERVAL_DATETIME", "INCOMPLETE_DATETIME", "INCOMPLETE_DATE", "INCOMPLETE_TIME" ]
-
description: object
Description
-
externalQuestion: object
ExternalQuestion
-
length: integer
-
measurementUnitRef: array
MeasurementUnitRef
-
name: string
-
oid: string
-
origin: string
-
question: object
Question
-
rangeCheck: array
RangeCheck
-
role: array
Role
-
sasfieldName: string
-
sdsvarName: string
-
significantDigits: integer
Nested Schema : RangeCheck
Type:
Show Source
object
-
checkValue: array
CheckValue
-
comparator: string
Allowed Values:
[ "LT", "LE", "GT", "GE", "EQ", "NE", "IN", "NOTIN" ]
-
errorMessage: object
ErrorMessage
-
formalExpression: array
FormalExpression
-
measurementUnitRef: object
MeasurementUnitRef
-
softHard: string
Allowed Values:
[ "SOFT", "HARD" ]
Nested Schema : ItemGroupDef
Type:
Show Source
object
-
alias: array
Alias
-
comment: string
-
description: object
Description
-
domain: string
-
isReferenceData: string
Allowed Values:
[ "YES", "NO" ]
-
itemRef: array
ItemRef
-
name: string
-
oid: string
-
origin: string
-
purpose: string
-
repeating: string
Allowed Values:
[ "YES", "NO" ]
-
role: string
-
sasdatasetName: string
Nested Schema : MethodDef
Type:
Show Source
object
-
alias: array
Alias
-
description(required): object
Description
-
formalExpression: array
FormalExpression
-
name: string
-
oid: string
-
type: string
Allowed Values:
[ "COMPUTATION", "IMPUTATION", "TRANSPOSE", "OTHER" ]
Nested Schema : StudyEventRef
Type:
Show Source
object
-
collectionExceptionConditionOID: string
-
mandatory: string
Allowed Values:
[ "YES", "NO" ]
-
orderNumber: integer
-
studyEventOID: string
Nested Schema : StudyEventDef
Type:
Show Source
object
-
alias: array
Alias
-
category: string
-
description: object
Description
-
formRef: array
FormRef
-
name: string
-
oid: string
-
repeating: string
Allowed Values:
[ "YES", "NO" ]
-
type: string
Allowed Values:
[ "SCHEDULED", "UNSCHEDULED", "COMMON" ]
Nested Schema : FormRef
Type:
Show Source
object
-
collectionExceptionConditionOID: string
-
formOID: string
-
mandatory: string
Allowed Values:
[ "YES", "NO" ]
-
orderNumber: integer