Jump to

• Request
• Response

Get metadata of a specified study ID and study version

get

/ec-designer-svc/rest/v1.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

• format(required): string
  Format for the study metadata

  Allowed Values: [ "unique", "casebook" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Study

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

Nested Schema : Study

Type: object

Show Source

• BasicDefinitions: object BasicDefinitions
• GlobalVariables: object GlobalVariables
• MetaDataVersion: array MetaDataVersion
• OID: string

{
    "type":"object",
    "properties":{
        "GlobalVariables":{
            "$ref":"#/components/schemas/GlobalVariables"
        },
        "BasicDefinitions":{
            "$ref":"#/components/schemas/BasicDefinitions"
        },
        "MetaDataVersion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetaDataVersion"
            }
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : BasicDefinitions

Type: object

Show Source

• MeasurementUnit: array MeasurementUnit

{
    "type":"object",
    "properties":{
        "MeasurementUnit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MeasurementUnit"
            }
        }
    }
}

Nested Schema : GlobalVariables

Type: object

Show Source

• ProtocolName: object ProtocolName
• StudyDescription: object StudyDescription
• StudyName: object StudyName

{
    "type":"object",
    "properties":{
        "StudyName":{
            "$ref":"#/components/schemas/StudyName"
        },
        "StudyDescription":{
            "$ref":"#/components/schemas/StudyDescription"
        },
        "ProtocolName":{
            "$ref":"#/components/schemas/ProtocolName"
        }
    }
}

Nested Schema : MetaDataVersion

Type: array

Show Source

• Array of: object MetaDataVersion

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

Nested Schema : MeasurementUnit

Type: array

Show Source

• Array of: object MeasurementUnit

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

Nested Schema : MeasurementUnit

Type: object

Show Source

• Alias: array Alias
• Name: string
• OID: string
• Symbol: object Symbol

{
    "type":"object",
    "properties":{
        "Symbol":{
            "$ref":"#/components/schemas/Symbol"
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : Symbol

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : Alias

Type: object

Show Source

• Context: string
• Name: string

{
    "type":"object",
    "properties":{
        "Context":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : TranslatedText

Type: object

Show Source

• lang: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "lang":{
            "type":"string"
        }
    }
}

Nested Schema : ProtocolName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : StudyDescription

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : StudyName

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : MetaDataVersion

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Include":{
            "$ref":"#/components/schemas/Include"
        },
        "Protocol":{
            "$ref":"#/components/schemas/Protocol"
        },
        "StudyEventDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventDef"
            }
        },
        "FormDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormDef"
            }
        },
        "ItemGroupDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupDef"
            }
        },
        "ItemDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemDef"
            }
        },
        "CodeList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeList"
            }
        },
        "ImputationMethod":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImputationMethod"
            }
        },
        "Presentation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Presentation"
            }
        },
        "ConditionDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConditionDef"
            }
        },
        "MethodDef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MethodDef"
            }
        },
        "Name":{
            "type":"string"
        },
        "Description":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : CodeList

Type: array

Show Source

• Array of: object CodeList

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

Nested Schema : ConditionDef

Type: array

Show Source

• Array of: object ConditionDef

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

Nested Schema : FormDef

Type: array

Show Source

• Array of: object FormDef

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

Nested Schema : ImputationMethod

Type: array

Show Source

• Array of: object ImputationMethod

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

Nested Schema : Include

Type: object

Show Source

• MetaDataVersionOID: string
• StudyOID: string

{
    "type":"object",
    "properties":{
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemDef

Type: array

Show Source

• Array of: object ItemDef

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

Nested Schema : ItemGroupDef

Type: array

Show Source

• Array of: object ItemGroupDef

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

Nested Schema : MethodDef

Type: array

Show Source

• Array of: object MethodDef

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

Nested Schema : Presentation

Type: array

Show Source

• Array of: object Presentation

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

Nested Schema : Protocol

Type: object

Show Source

• Alias: array Alias
• Description: object Description
• StudyEventRef: array StudyEventRef

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "StudyEventRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventRef"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        }
    }
}

Nested Schema : StudyEventDef

Type: array

Show Source

• Array of: object StudyEventDef

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

Nested Schema : CodeList

Type: object

Show Source

• Alias: array Alias
• DataType: string
  Allowed Values: [ "INTEGER", "FLOAT", "TEXT", "STRING" ]
• Description: object Description
• EnumeratedItem: array EnumeratedItem
• ExternalCodeList: object ExternalCodeList
• Items: array Items
• Name: string
• OID: string
• SasformatName: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "ExternalCodeList":{
            "$ref":"#/components/schemas/ExternalCodeList"
        },
        "EnumeratedItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnumeratedItem"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "DataType":{
            "type":"string",
            "enum":[
                "INTEGER",
                "FLOAT",
                "TEXT",
                "STRING"
            ]
        },
        "SasformatName":{
            "type":"string"
        },
        "Items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeListItem"
            }
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : Description

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : EnumeratedItem

Type: array

Show Source

• Array of: object EnumeratedItem

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

Nested Schema : ExternalCodeList

Type: object

Show Source

• Dictionary: string
• Href: string
• Ref: string
• Version: string

{
    "type":"object",
    "properties":{
        "Href":{
            "type":"string"
        },
        "Ref":{
            "type":"string"
        },
        "Dictionary":{
            "type":"string"
        },
        "Version":{
            "type":"string"
        }
    }
}

Nested Schema : Items

Type: array

Show Source

• Array of: object CodeListItem

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

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : EnumeratedItem

Type: object

Show Source

• Alias: array Alias
• CodedValue: string
• OrderNumber: integer
• Rank: number

{
    "type":"object",
    "properties":{
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "CodedValue":{
            "type":"string"
        },
        "Rank":{
            "type":"number"
        },
        "OrderNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : CodeListItem

Type: object

Show Source

• Alias: array Alias
• CodedValue: string
• Decode: object Decode
• OrderNumber: integer

{
    "type":"object",
    "properties":{
        "Decode":{
            "$ref":"#/components/schemas/Decode"
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "CodedValue":{
            "type":"string"
        },
        "OrderNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : Decode

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : ConditionDef

Type: object

Show Source

• Alias: array Alias
• Description: object Description
• FormalExpression: array FormalExpression
• Name: string
• OID: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "FormalExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : FormalExpression

Type: array

Show Source

• Array of: object FormalExpression

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

Nested Schema : FormalExpression

Type: object

Show Source

• Context: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "Context":{
            "type":"string"
        }
    }
}

Nested Schema : FormDef

Type: object

Show Source

• Alias: array Alias
• ArchiveLayout: array ArchiveLayout
• Description: object Description
• HasIPR: boolean
• ID: string
• ItemGroupRef: array ItemGroupRef
• Name: string
• Note: string
• OID: string
• Repeating: string
  Allowed Values: [ "Yes", "No" ]
• RevisionDate: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "ItemGroupRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupRef"
            }
        },
        "ArchiveLayout":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArchiveLayout"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Repeating":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "HasIPR":{
            "type":"boolean"
        },
        "Note":{
            "type":"string"
        },
        "RevisionDate":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : ArchiveLayout

Type: array

Show Source

• Array of: object ArchiveLayout

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

Nested Schema : ItemGroupRef

Type: array

Show Source

• Array of: object ItemGroupRef

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

Nested Schema : ArchiveLayout

Type: object

Show Source

• OID: string
• PdfFileName: string
• PresentationOID: string

{
    "type":"object",
    "properties":{
        "PdfFileName":{
            "type":"string"
        },
        "PresentationOID":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupRef

Type: object

Show Source

• CollectionExceptionConditionOID: string
• ItemGroupOID: string
• Mandatory: string
  Allowed Values: [ "Yes", "No" ]
• OrderNumber: integer

{
    "type":"object",
    "properties":{
        "OrderNumber":{
            "type":"integer"
        },
        "Mandatory":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "CollectionExceptionConditionOID":{
            "type":"string"
        },
        "ItemGroupOID":{
            "type":"string"
        }
    }
}

Nested Schema : ImputationMethod

Type: object

Show Source

• OID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemDef

Type: object

Show Source

• Alias: array Alias
• Calculated: string
• CaptionAlignment: string
  Allowed Values: [ "0", "1", "2", "3", "4", "5", "6" ]
• CaptionText: string
• CodeListRef: object CodeListRef
• Comment: string
• ControlLayout: string
  Allowed Values: [ "0", "1", "2", "3", "4", "5" ]
• ControlType: string
  Allowed Values: [ "pulldown", "text", "group", "radiogroup", "checkbox", "calendar", "element", "calculated", "instructionaltext" ]
• DataType: string
  Allowed Values: [ "integer", "float", "date", "datetime", "time", "text", "string", "double", "URI", "boolean", "hexBinary", "base64Binary", "hexFloat", "base64Float", "partialDate", "partialTime", "partialDatetime", "durationDatetime", "intervalDatetime", "incompleteDatetime", "incompleteDate", "incompleteTime" ]
• Description: object Description
• DisplayMask: string
• EndYear: string
• ExternalQuestion: object ExternalQuestion
• InitialRowCount: string
• IsDynamic: integer (int32)
• IsSmartItem: integer (int32)
• ItemRef: array ItemRef
• Length: integer
• MeasurementUnitRef: array MeasurementUnitRef
• Name: string
• OID: string
• Origin: string
• Question: object Question
• RangeCheck: array RangeCheck
• Role: array Role
• SasfieldName: string
• SdsvarName: string
• SelectionValue: string
• SignificantDigits: integer
• StartYear: string
• UnknownMask: string

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "Question":{
            "$ref":"#/components/schemas/Question"
        },
        "ExternalQuestion":{
            "$ref":"#/components/schemas/ExternalQuestion"
        },
        "MeasurementUnitRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MeasurementUnitRef"
            }
        },
        "RangeCheck":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RangeCheck"
            }
        },
        "CodeListRef":{
            "$ref":"#/components/schemas/CodeListRef"
        },
        "Role":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "DataType":{
            "type":"string",
            "enum":[
                "integer",
                "float",
                "date",
                "datetime",
                "time",
                "text",
                "string",
                "double",
                "URI",
                "boolean",
                "hexBinary",
                "base64Binary",
                "hexFloat",
                "base64Float",
                "partialDate",
                "partialTime",
                "partialDatetime",
                "durationDatetime",
                "intervalDatetime",
                "incompleteDatetime",
                "incompleteDate",
                "incompleteTime"
            ]
        },
        "Length":{
            "type":"integer"
        },
        "SignificantDigits":{
            "type":"integer"
        },
        "Origin":{
            "type":"string"
        },
        "Comment":{
            "type":"string"
        },
        "CaptionText":{
            "type":"string"
        },
        "ControlType":{
            "type":"string",
            "enum":[
                "pulldown",
                "text",
                "group",
                "radiogroup",
                "checkbox",
                "calendar",
                "element",
                "calculated",
                "instructionaltext"
            ]
        },
        "ControlLayout":{
            "type":"string",
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ]
        },
        "CaptionAlignment":{
            "type":"string",
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5",
                "6"
            ]
        },
        "InitialRowCount":{
            "type":"string"
        },
        "DisplayMask":{
            "type":"string"
        },
        "StartYear":{
            "type":"string"
        },
        "EndYear":{
            "type":"string"
        },
        "UnknownMask":{
            "type":"string"
        },
        "Calculated":{
            "type":"string"
        },
        "SelectionValue":{
            "type":"string"
        },
        "ItemRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemRef"
            }
        },
        "IsDynamic":{
            "type":"integer",
            "format":"int32"
        },
        "IsSmartItem":{
            "type":"integer",
            "format":"int32"
        },
        "SasfieldName":{
            "type":"string"
        },
        "SdsvarName":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : CodeListRef

Type: object

Show Source

• CodeListOID: string

{
    "type":"object",
    "properties":{
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : ExternalQuestion

Type: object

Show Source

• Code: string
• Dictionary: string
• Version: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Dictionary":{
            "type":"string"
        },
        "Version":{
            "type":"string"
        }
    }
}

Nested Schema : ItemRef

Type: array

Show Source

• Array of: object ItemRef

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

Nested Schema : MeasurementUnitRef

Type: array

Show Source

• Array of: object MeasurementUnitRef

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

Nested Schema : Question

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : RangeCheck

Type: array

Show Source

• Array of: object RangeCheck

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

Nested Schema : Role

Type: array

Show Source

• Array of: object Role

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

Nested Schema : ItemRef

Type: object

Show Source

• CollectionExceptionConditionOID: string
• ImputationMethodOID: string
• ItemOID: string
• KeySequence: integer
• Mandatory: string
  Allowed Values: [ "Yes", "No" ]
• MethodOID: string
• OrderNumber: integer
• Role: string
• RoleCodeListOID: string

{
    "type":"object",
    "properties":{
        "ItemOID":{
            "type":"string"
        },
        "KeySequence":{
            "type":"integer"
        },
        "MethodOID":{
            "type":"string"
        },
        "ImputationMethodOID":{
            "type":"string"
        },
        "Role":{
            "type":"string"
        },
        "RoleCodeListOID":{
            "type":"string"
        },
        "OrderNumber":{
            "type":"integer"
        },
        "Mandatory":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "CollectionExceptionConditionOID":{
            "type":"string"
        }
    }
}

Nested Schema : MeasurementUnitRef

Type: object

Show Source

• MeasurementUnitOID: string

{
    "type":"object",
    "properties":{
        "MeasurementUnitOID":{
            "type":"string"
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : RangeCheck

Type: object

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "CheckValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CheckValue"
            }
        },
        "FormalExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "MeasurementUnitRef":{
            "$ref":"#/components/schemas/MeasurementUnitRef"
        },
        "ErrorMessage":{
            "$ref":"#/components/schemas/ErrorMessage"
        },
        "Comparator":{
            "type":"string",
            "enum":[
                "LT",
                "LE",
                "GT",
                "GE",
                "EQ",
                "NE",
                "IN",
                "NOTIN"
            ]
        },
        "SoftHard":{
            "type":"string",
            "enum":[
                "SOFT",
                "HARD"
            ]
        }
    }
}

Nested Schema : CheckValue

Type: array

Show Source

• Array of: object CheckValue

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

Nested Schema : ErrorMessage

Type: object

Show Source

• TranslatedText: array TranslatedText

{
    "type":"object",
    "properties":{
        "TranslatedText":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TranslatedText"
            }
        }
    }
}

Nested Schema : FormalExpression

Type: array

Show Source

• Array of: object FormalExpression

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

Nested Schema : CheckValue

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : TranslatedText

Type: array

Show Source

• Array of: object TranslatedText

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

Nested Schema : Role

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupDef

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "ItemRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemRef"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Repeating":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "IsReferenceData":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "Domain":{
            "type":"string"
        },
        "Origin":{
            "type":"string"
        },
        "Role":{
            "type":"string"
        },
        "Purpose":{
            "type":"string"
        },
        "Comment":{
            "type":"string"
        },
        "SasdatasetName":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : ItemRef

Type: array

Show Source

• Array of: object ItemRef

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

Nested Schema : MethodDef

Type: object

Show Source

• Alias: array Alias
• Description: object Description
• FormalExpression: array FormalExpression
• Name: string
• OID: string
• Type: string
  Allowed Values: [ "COMPUTATION", "IMPUTATION", "TRANSPOSE", "OTHER" ]

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "FormalExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormalExpression"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Type":{
            "type":"string",
            "enum":[
                "COMPUTATION",
                "IMPUTATION",
                "TRANSPOSE",
                "OTHER"
            ]
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : FormalExpression

Type: array

Show Source

• Array of: object FormalExpression

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

Nested Schema : Presentation

Type: object

Show Source

• Lang: string
• OID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "Lang":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : StudyEventRef

Type: array

Show Source

• Array of: object StudyEventRef

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

Nested Schema : StudyEventRef

Type: object

Show Source

• CollectionExceptionConditionOID: string
• Mandatory: string
  Allowed Values: [ "Yes", "No" ]
• OrderNumber: integer
• StudyEventOID: string

{
    "type":"object",
    "properties":{
        "OrderNumber":{
            "type":"integer"
        },
        "Mandatory":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "CollectionExceptionConditionOID":{
            "type":"string"
        },
        "StudyEventOID":{
            "type":"string"
        }
    }
}

Nested Schema : StudyEventDef

Type: object

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/Description"
        },
        "FormRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormRef"
            }
        },
        "Alias":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Alias"
            }
        },
        "Name":{
            "type":"string"
        },
        "Repeating":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "Type":{
            "type":"string",
            "enum":[
                "Scheduled",
                "Unscheduled",
                "Common"
            ]
        },
        "Category":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Alias

Type: array

Show Source

• Array of: object Alias

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

Nested Schema : FormRef

Type: array

Show Source

• Array of: object FormRef

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

Nested Schema : FormRef

Type: object

Show Source

• CollectionExceptionConditionOID: string
• FormOID: string
• Mandatory: string
  Allowed Values: [ "Yes", "No" ]
• OrderNumber: integer

{
    "type":"object",
    "properties":{
        "FormOID":{
            "type":"string"
        },
        "OrderNumber":{
            "type":"integer"
        },
        "Mandatory":{
            "type":"string",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "CollectionExceptionConditionOID":{
            "type":"string"
        }
    }
}

404 Response

Error

Body ()

Root 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 : details

Type: object

500 Response

Error

Body ()

Root 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 : details

Type: object

Back to Top