1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Form APIs
  5. Forms
  6. Get list questions used in stratified randomization

V13.0

get

/ec-designer-ors-svc/rest/v13.0/studies/{studyId}/versions/{version}/forms/randomizationfactors

Retrieves all questions used in stratified randomization designs in a specific study version.

Request

Path Parameters
Query Parameters
  • Optional. When true, excludes laboratory form items from the response.
    Default Value: false
    Example:
    false
  • Optional. When true, excludes repeat form items from the response.
    Default Value: false
    Example:
    false
  • Optional. When true, excludes form items from two-section forms from the response.
    Default Value: false
    Example:
    false
  • Minimum Length: 3
    Maximum Length: 3
    Optional. Form category filter. Allowed values: DCS for Data Collection Study forms, NSF for Clinical Supplies Data forms, and ALL for all supported form categories. Defaults to DCS when omitted.
    Default Value: DCS
    Allowed Values: [ "DCS", "NSF", "ALL" ]
    Example:
    DCS
  • Optional. When true, includes all number items that are eligible for stratification.
    Default Value: false
    Example:
    false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Randomization factor form items were retrieved successfully for the requested study version.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : FormsRandomizationFactorItemV13
Type: object
Randomization factor form item details returned by the v13 forms randomization factors endpoint.
Show Source
  • advancedProps
    Advanced property mappings configured for the form item.
  • Indicates whether additional rows can be added to a table item.
    Example: false
  • Minimum Value: 0
    Maximum Value: 1
    Indicates whether future dates are allowed. Allowed values are 0 and 1.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 1
    Indicates whether partial dates are allowed. Allowed values are 0 and 1.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 32
    Study version that should also receive the item change when apply-to-version is used.
    Example: 1.0.0.1
  • Minimum Length: 1
    Maximum Length: 4000
    Linked code list description for choice items.
    Example: Standard gender codelist
  • Minimum Length: 1
    Maximum Length: 255
    Lab normals tag assigned through the linked code list.
    Example: LabGender
  • Minimum Length: 1
    Maximum Length: 255
    Linked code list title for choice items.
    Example: Gender
  • Minimum Length: 32
    Maximum Length: 32
    Choice column layout identifier.
    Example: EBCF17C5F8D4460AA4A9673485C79CF0
  • Minimum Length: 1
    Maximum Length: 255
    Choice column layout label.
    Example: Single
  • dataClassificationIds
    Data classification mappings associated with the item.
  • Minimum Length: 1
    Maximum Length: 255
    Assigned data classification level when present.
    Example: edit
  • Minimum Length: 1
    Maximum Length: 32
    Choice display mode.
    Example: selectbox
  • Minimum Value: 0
    Number of leading questions that must be satisfied before this item is shown. Negative values are not allowed.
    Example: 0
  • e2br3Mapping
    E2B(R3) mappings associated with the item.
  • Minimum Length: 1
    Maximum Length: 255
    Existing-data code list name.
    Example: EDLSite
  • Minimum Length: 1
    Maximum Length: 255
    Existing-data code list value.
    Example: SiteName
  • Minimum Length: 1
    Maximum Length: 32
    Date or date-time format.
    Example: yyyy-MM-dd
  • Minimum Length: 3
    Maximum Length: 3
    Form category for the item.
    Example: DCS
  • Minimum Length: 32
    Maximum Length: 32
    Parent form unique identifier.
  • Minimum Length: 1
    Maximum Length: 255
    Form subcategory for the item when present.
    Example: Baseline
  • Minimum Length: 1
    Maximum Length: 4000
    Parent form title.
    Example: Demography
  • Minimum Length: 1
    Maximum Length: 4000
    Smart item formula definition.
    Example: [{"ruleName":"AGE","ruleExpression":"AgeInYears(AGE_DOB_01, visitDate)"}]
  • Minimum Value: 0
    Group display order for grouped items. Negative values are not allowed.
    Example: 0
  • Indicates whether the item is hidden.
    Example: false
  • Minimum Length: 32
    Maximum Length: 32
    Form item unique identifier.
  • Indicates whether the linked code list has been replaced.
    Example: false
  • Indicates whether the item is tagged as a cohort factor.
    Example: false
  • Indicates whether the item is tagged as a strata factor.
    Example: true
  • items
    Child items contained in a question group, table, or section item.
  • Minimum Length: 1
    Maximum Length: 255
    Lab normals tag assigned to the item.
    Example: LabTest
  • Minimum Value: 0
    Maximum Value: 4000
    Maximum text length for text items. Negative values are not allowed.
    Example: 4000
  • Indicates whether the text item supports multiple lines.
    Example: false
  • options
    Choice options available for choice and label items.
  • Minimum Length: 1
    Maximum Length: 32
    Partial date format used when partial dates are allowed.
    Example: MMM-yyyy
  • Minimum Value: 0
    Numeric precision for numeric items. Negative values are not allowed.
    Example: 0
  • Minimum Length: 1
    Maximum Length: 4000
    Question hint shown in the UI when configured.
    Example: Enter the subject age in years.
  • Minimum Length: 1
    Maximum Length: 4000
    Question label displayed to study designers.
    Example: Age
  • Minimum Length: 4
    Maximum Length: 17
    Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]
    Question type. Allowed values: text = free-text question, instructionalText = read-only instructional content, numeric = numeric question, datetime = date or date-time question, choice = coded selection question, questionGroup = grouped child questions, table = tabular child question group, label = non-editable label-style choice item, section = section container for grouped questions, existingData = value sourced from existing study data, fileUpload = file attachment question.
    Example: numeric
  • Indicates whether the item is tagged for randomization.
    Example: true
  • Indicates whether the item is read-only.
    Example: false
  • Minimum Length: 1
    Maximum Length: 64
    Stable form item reference name.
    Example: AGE_01
  • Indicates whether a response is required for the item.
    Example: true
  • Indicates whether the item is required for dispensation.
    Example: false
  • Indicates whether the item is required for safety case creation.
    Example: false
  • Indicates whether the item is required for randomization.
    Example: true
  • Indicates whether the item is required for screening.
    Example: false
  • Minimum Length: 1
    Maximum Length: 4000
    JSON-formatted rule set used to validate answers.
    Example: {"logicalOperator":"NONE","rules":[],"numberIndex":1}
  • Minimum Length: 1
    Maximum Length: 4000
    SAS label used for downstream extracts.
    Example: Subject Age
  • Minimum Length: 1
    Maximum Length: 255
    SAS variable name used for downstream extracts.
    Example: AGE
  • Minimum Length: 6
    Maximum Length: 8
    Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]
    Source Data Verification requirement. Allowed values: NOTSET = no explicit SDV setting is configured, NEVER = SDV is not required, ALWAYS = SDV is always required, CRITICAL = SDV is required only for critical data.
    Example: NEVER
  • Minimum Value: 0
    Item display order within the form. Negative values are not allowed.
    Example: 1
  • Minimum Length: 32
    Maximum Length: 32
    Linked smart item unique identifier.
  • Minimum Length: 1
    Maximum Length: 255
    Smart object identifier used by the formula.
    Example: AGE
  • Indicates whether the item can trigger a follow-up case.
    Example: false
  • Minimum Length: 1
    Maximum Length: 255
    Measurement units for numeric items.
    Example: years
  • Minimum Length: 32
    Maximum Length: 32
    Assigned visit unique identifier when the item is scoped to a single visit.
  • visitIds
    Assigned visit identifiers when the item is scoped to multiple visits.
Nested Schema : advancedProps
Type: array
Advanced property mappings configured for the form item.
Show Source
Example:
[
    {
        "id":"2E2D8A4E3F5C4C2F96A43B9F0BEF5142",
        "type":"RolloverQuestion",
        "name":"RolloverQuestionStudyId",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Rollover Study BT-31",
        "rules":[
            {
                "name":"RolloverQuestionAnswer",
                "value":"91A0C3E0D0B5445A95BA3AB2D84D6755",
                "label":"Yes"
            }
        ],
        "parentObjectId":"7F6C4D52A1D04CF9A75D06B2F454A172",
        "parentObjectLevel":"FORM",
        "parentObjectLabel":"Demography"
    }
]
Nested Schema : dataClassificationIds
Type: array
Data classification mappings associated with the item.
Show Source
Example:
[
    {
        "id":"F5BBE9E730234785A64C593C3EE4F8AA",
        "type":"DataClassification",
        "name":"ClassificationId",
        "value":"SUBJECT",
        "label":"Subject Data",
        "rules":[
            {
                "name":"Access",
                "value":"EDIT",
                "label":"Edit"
            }
        ],
        "parentObjectId":"7F6C4D52A1D04CF9A75D06B2F454A172",
        "parentObjectLevel":"FORM",
        "parentObjectLabel":"Demography"
    }
]
Nested Schema : e2br3Mapping
Type: array
E2B(R3) mappings associated with the item.
Show Source
Example:
[
    {
        "id":"5FDFAB0EEAE34950B0DEBFC2DD0B8D20",
        "type":"E2BR3Mapping",
        "name":"E2BR3Field",
        "value":"patient.agegroup",
        "label":"Patient Age Group",
        "rules":[
            {
                "name":"Profile",
                "value":"DEFAULT",
                "label":"Default"
            }
        ],
        "parentObjectId":"7F6C4D52A1D04CF9A75D06B2F454A172",
        "parentObjectLevel":"FORM",
        "parentObjectLabel":"Demography"
    }
]
Nested Schema : items
Type: array
Child items contained in a question group, table, or section item.
Show Source
Example:
[
    {
        "questionType":"text",
        "id":"D4F7297E3E2C4D8A91C09938F31A7AC1",
        "questionLabel":"Weight comment",
        "refname":"WEIGHT_COMMENT",
        "required":false,
        "sdvRequired":"NOTSET",
        "maxlength":4000,
        "multiline":true
    }
]
Nested Schema : options
Type: array
Choice options available for choice and label items.
Show Source
Example:
[
    {
        "label":"Yes",
        "value":"1",
        "clCode":"Y",
        "clDescription":"Yes",
        "clValue":"Yes",
        "clItemId":"91A0C3E0D0B5445A95BA3AB2D84D6755",
        "hidden":false,
        "optionSeq":"1"
    }
]
Nested Schema : visitIds
Type: array
Assigned visit identifiers when the item is scoped to multiple visits.
Show Source
  • Assigned visit identifiers when the item is scoped to multiple visits.
    Example: ["E1D7C7D4D8444D60A5304F0E0A9967D1"]
Example:
[
    "E1D7C7D4D8444D60A5304F0E0A9967D1"
]
Nested Schema : FormsRandomizationFactorAdvancedPropV13
Type: object
Advanced property mapping details for a randomization factor form item.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Advanced property unique identifier.
  • Minimum Length: 1
    Maximum Length: 4000
    Advanced property label shown in the UI.
    Example: Rollover Study BT-31
  • Minimum Length: 1
    Maximum Length: 255
    Advanced property name.
    Example: RolloverQuestionStudyId
  • Minimum Length: 32
    Maximum Length: 32
    Parent object identifier when the property is inherited from a parent object.
  • Minimum Length: 1
    Maximum Length: 4000
    Parent object label when present.
    Example: Demography
  • Minimum Length: 1
    Maximum Length: 255
    Parent object hierarchy level when present.
    Example: FORM
  • rules
    Rules attached to the advanced property.
  • Minimum Length: 1
    Maximum Length: 30
    Allowed Values: [ "RolloverQuestion", "CodeQuestion", "ShowQuestion", "ShowForm", "ShowVisit", "ShowSection", "StatusRule", "DataClassification", "VISITBRANCH", "LinkForm", "AssignedVisits", "TriggerSafetyCase", "EHRMapping", "E2BR3Mapping" ]
    Advanced property type. Allowed values: RolloverQuestion = rollover-study question mapping, CodeQuestion = coded-question mapping, ShowQuestion = conditional show rule for a question, ShowForm = conditional show rule for a form, ShowVisit = conditional show rule for a visit, ShowSection = conditional show rule for a section, StatusRule = status-driven rule, DataClassification = data classification mapping, VISITBRANCH = assigned visit-branch mapping, LinkForm = linked form action, AssignedVisits = assigned visit mapping, TriggerSafetyCase = safety case trigger mapping, EHRMapping = EHR field mapping, E2BR3Mapping = E2B(R3) field mapping.
    Example: RolloverQuestion
  • Minimum Length: 1
    Maximum Length: 2048
    Advanced property value.
    Example: B1B8327AFAA6412287106192AB5984EF
Nested Schema : rules
Type: array
Rules attached to the advanced property.
Show Source
Example:
[
    {
        "name":"RolloverQuestionAnswer",
        "value":"91A0C3E0D0B5445A95BA3AB2D84D6755",
        "label":"Yes"
    }
]
Nested Schema : FormsRandomizationFactorAdvancedPropRuleV13
Type: object
Advanced property rule details for a randomization factor form item.
Show Source
  • Minimum Length: 1
    Maximum Length: 4000
    Advanced property rule label shown in the UI.
    Example: Yes
  • Minimum Length: 1
    Maximum Length: 255
    Advanced property rule name.
    Example: RolloverQuestionAnswer
  • Minimum Length: 1
    Maximum Length: 2048
    Advanced property rule value.
    Example: 91A0C3E0D0B5445A95BA3AB2D84D6755
Nested Schema : FormsRandomizationFactorOptionV13
Type: object
Choice option details for a randomization factor form item.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Linked code list code.
    Example: Y
  • Minimum Length: 1
    Maximum Length: 4000
    Linked code list description.
    Example: Yes
  • Minimum Length: 32
    Maximum Length: 32
    Choice option code list item unique identifier.
  • Minimum Length: 1
    Maximum Length: 255
    Linked code list display value.
    Example: Yes
  • Minimum Length: 3
    Maximum Length: 3
    Form category for the option when present.
    Example: DCS
  • Minimum Length: 1
    Maximum Length: 255
    Form subcategory for the option when present.
    Example: Baseline
  • Indicates whether the option is hidden.
    Example: false
  • Minimum Length: 1
    Maximum Length: 4000
    Instructional text associated with the option.
    Example: Choose the option that applies.
  • Minimum Length: 1
    Maximum Length: 4000
    Choice option label.
    Example: Yes
  • Minimum Length: 1
    Maximum Length: 4000
    Choice option sequence value.
    Example: 1
  • Minimum Length: 1
    Maximum Length: 4000
    Choice option stored value.
    Example: 1
Examples

500 Response

Returned when the service cannot load the randomization factor form items for the supplied study version because of an unexpected server-side failure.
Body ()
Root Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : details
Type: object
Examples

Back to Top