Get metadata of a specified study ID and study version
get
/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/studyMetadata
Retrieves metadata for a specified study ID and study version.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
asofdate(required): string
Format for the study metadata
-
format(required): string
Format for the study metadataAllowed Values:
[ "unique", "casebook" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
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
404 Response
Error
Nested Schema : details
Type:
object
500 Response
Error
Nested Schema : details
Type:
object