Jump to

• Request
• Response

[Deprecated]: Get a specific form

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}

Deprecated: Use latest version instead. Retrieves a specific form in a study version.

Request

Path Parameters

• formId(required): string(uuid)
  The Form id
• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : FormDto v1.0

Type: object

Title: FormDto v1.0

Form Info

Show Source

• id: string (uuid)
  Form Unique GUID
• items: array items
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form refname

  Example: FORM_01
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form title

  Example: Demography

{
    "title":"FormDto v1.0",
    "required":[
        "refname",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "refname":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemDtoV1"
            }
        }
    },
    "description":"Form Info"
}

Nested Schema : items

Type: array

Show Source

• Array of: object FormItemDto v1.0
  Title: FormItemDto v1.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV1", "numeric":"#/components/schemas/FormNumberItemDtoV1", "measurement":"#/components/schemas/FormNumberItemDtoV1", "text":"#/components/schemas/FormTextItemDtoV1", "choice":"#/components/schemas/FormChoiceItemDtoV1" } }

  Form Item Information

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

Nested Schema : FormItemDto v1.0

Type: object

Title: FormItemDto v1.0

Discriminator: questionType

Discriminator Values

• datetime
• numeric
• measurement
• text
• choice

{
    "title":"FormItemDto v1.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "refname":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Source-Documented Verification: Whether proof of the answer required?",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":"1"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtoV1",
            "numeric":"#/components/schemas/FormNumberItemDtoV1",
            "measurement":"#/components/schemas/FormNumberItemDtoV1",
            "text":"#/components/schemas/FormTextItemDtoV1",
            "choice":"#/components/schemas/FormChoiceItemDtoV1"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV1"
        }
    ]
}

Form Item Information

Show Source

• formId: string (uuid)
  Form Unique GUID
• formTitle: string
  Form title

  Example: Demography
• id: string (uuid)
  Form Item Unique GUID
• isStrataFactor: boolean
  Flag that indicates whether this form item is used as a factor for randomization stratum or not.

  Example: false
• questionHint: string
  Minimum Length: 0

  Maximum Length: 4000

  Form question hint

  Example: What is your age?
• questionLabel(required): string
  Minimum Length: 1

  Maximum Length: 4000

  Form question label

  Example: Age
• questionType(required): string
• randomizationTag: boolean
  Flag that indicates whether this form item should be used for randomization stratification or not.

  Example: true
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form item reference name.

  Example: NUMBER_01
• required(required): boolean
  Whether this form item is requiered or not.

  Example: true
• ruleSet: string
  A JSON-formatted set of rules to do validation of the answers.

  Example: {'logicalOperator':'NONE','rules':[],'numberIndex':1}
• sdvRequired(required): boolean
  Source-Documented Verification: Whether proof of the answer required?

  Example: false
• sequence: integer (int32)
  Item position in the form.

  Example: 1

{
    "title":"FormItemDto v1.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "refname":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Source-Documented Verification: Whether proof of the answer required?",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":"1"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtoV1",
            "numeric":"#/components/schemas/FormNumberItemDtoV1",
            "measurement":"#/components/schemas/FormNumberItemDtoV1",
            "text":"#/components/schemas/FormTextItemDtoV1",
            "choice":"#/components/schemas/FormChoiceItemDtoV1"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV1"
        }
    ]
}

Match One Schema

Show Source

• object FormNumberItemDto v1.0
  Title: FormNumberItemDto v1.0

  Form Number Item Details Information
• object FormChoiceItemDto v1.0
  Title: FormChoiceItemDto v1.0

  Form Choice Item Details Information
• object FormTextItemDto v1.0
  Title: FormTextItemDto v1.0

  Form text Item Details Information
• object FormDatetimeItemDto v1.0
  Title: FormDatetimeItemDto v1.0

  Form DateTime Item Details Information

{
    "title":"FormItemDto v1.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "refname":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"boolean",
            "description":"Source-Documented Verification: Whether proof of the answer required?",
            "example":false
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":"1"
        },
        "questionType":{
            "type":"string"
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtoV1",
            "numeric":"#/components/schemas/FormNumberItemDtoV1",
            "measurement":"#/components/schemas/FormNumberItemDtoV1",
            "text":"#/components/schemas/FormTextItemDtoV1",
            "choice":"#/components/schemas/FormChoiceItemDtoV1"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV1"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV1"
        }
    ]
}

Nested Schema : FormNumberItemDto v1.0

Type: object

Title: FormNumberItemDto v1.0

Form Number Item Details Information

Match All

Show Source

• object FormItemDto v1.0
  Title: FormItemDto v1.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV1", "numeric":"#/components/schemas/FormNumberItemDtoV1", "measurement":"#/components/schemas/FormNumberItemDtoV1", "text":"#/components/schemas/FormTextItemDtoV1", "choice":"#/components/schemas/FormChoiceItemDtoV1" } }

  Form Item Information
• object FormNumberItemDto v1.0-allOf[1]

{
    "title":"FormNumberItemDto v1.0",
    "required":[
        "precision",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Number Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV1"
        },
        {
            "type":"object",
            "properties":{
                "precision":{
                    "minimum":"0",
                    "type":"integer",
                    "description":"Number value precision",
                    "format":"int32",
                    "example":"1"
                },
                "units":{
                    "type":"string",
                    "description":"Units of measure",
                    "example":"kg"
                }
            }
        }
    ]
}

Nested Schema : FormChoiceItemDto v1.0

Type: object

Title: FormChoiceItemDto v1.0

Form Choice Item Details Information

Match All

Show Source

• object FormItemDto v1.0
  Title: FormItemDto v1.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV1", "numeric":"#/components/schemas/FormNumberItemDtoV1", "measurement":"#/components/schemas/FormNumberItemDtoV1", "text":"#/components/schemas/FormTextItemDtoV1", "choice":"#/components/schemas/FormChoiceItemDtoV1" } }

  Form Item Information
• object FormChoiceItemDto v1.0-allOf[1]

{
    "title":"FormChoiceItemDto v1.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Choice Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV1"
        },
        {
            "type":"object",
            "properties":{
                "display":{
                    "pattern":"selectbox",
                    "type":"string",
                    "description":"Form choice item display in UI - Selectbox.",
                    "example":"selectbox"
                },
                "options":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormOptionDtoV1"
                    }
                }
            }
        }
    ]
}

Nested Schema : FormTextItemDto v1.0

Type: object

Title: FormTextItemDto v1.0

Form text Item Details Information

Match All

Show Source

• object FormItemDto v1.0
  Title: FormItemDto v1.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV1", "numeric":"#/components/schemas/FormNumberItemDtoV1", "measurement":"#/components/schemas/FormNumberItemDtoV1", "text":"#/components/schemas/FormTextItemDtoV1", "choice":"#/components/schemas/FormChoiceItemDtoV1" } }

  Form Item Information
• object FormTextItemDto v1.0-allOf[1]

{
    "title":"FormTextItemDto v1.0",
    "required":[
        "maxlength",
        "multiline",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form text Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV1"
        },
        {
            "type":"object",
            "properties":{
                "maxlength":{
                    "maximum":"4000",
                    "minimum":"0",
                    "type":"integer",
                    "description":"Form text item max length",
                    "format":"int32",
                    "example":"4000"
                },
                "multiline":{
                    "type":"boolean",
                    "description":"Is form text item multiline",
                    "example":false
                }
            }
        }
    ]
}

Nested Schema : FormDatetimeItemDto v1.0

Type: object

Title: FormDatetimeItemDto v1.0

Form DateTime Item Details Information

Match All

Show Source

• object FormItemDto v1.0
  Title: FormItemDto v1.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV1", "numeric":"#/components/schemas/FormNumberItemDtoV1", "measurement":"#/components/schemas/FormNumberItemDtoV1", "text":"#/components/schemas/FormTextItemDtoV1", "choice":"#/components/schemas/FormChoiceItemDtoV1" } }

  Form Item Information
• object FormDatetimeItemDto v1.0-allOf[1]

{
    "title":"FormDatetimeItemDto v1.0",
    "required":[
        "format",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form DateTime Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV1"
        },
        {
            "type":"object",
            "properties":{
                "format":{
                    "pattern":"YYYY|MON-YYYY|DD-MON-YYYY|DD-MON-YYYY HH:MM",
                    "type":"string",
                    "description":"Date time format",
                    "example":"DD-MON-YYYY"
                }
            }
        }
    ]
}

Nested Schema : FormNumberItemDto v1.0-allOf[1]

Type: object

Show Source

• precision: integer (int32)
  Minimum Value: 0

  Number value precision

  Example: 1
• units: string
  Units of measure

  Example: kg

{
    "type":"object",
    "properties":{
        "precision":{
            "minimum":"0",
            "type":"integer",
            "description":"Number value precision",
            "format":"int32",
            "example":"1"
        },
        "units":{
            "type":"string",
            "description":"Units of measure",
            "example":"kg"
        }
    }
}

Nested Schema : FormChoiceItemDto v1.0-allOf[1]

Type: object

Show Source

• display: string
  Pattern: selectbox

  Form choice item display in UI - Selectbox.

  Example: selectbox
• options: array options

{
    "type":"object",
    "properties":{
        "display":{
            "pattern":"selectbox",
            "type":"string",
            "description":"Form choice item display in UI - Selectbox.",
            "example":"selectbox"
        },
        "options":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormOptionDtoV1"
            }
        }
    }
}

Nested Schema : options

Type: array

Show Source

• Array of: object FormOptionDto v1.0
  Title: FormOptionDto v1.0

  Form choice item option details

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

Nested Schema : FormOptionDto v1.0

Type: object

Title: FormOptionDto v1.0

Form choice item option details

Show Source

• label: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox label for a one specific choice.

  Example: Female
• value: string
  Minimum Length: 1

  Maximum Length: 4000

  Pattern: [a-zA-Z0-9]+

  Form choice selectbox value for a one specific choice.

  Example: 1

{
    "title":"FormOptionDto v1.0",
    "type":"object",
    "properties":{
        "label":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"Form choice selectbox label for a one specific choice.",
            "example":"Female"
        },
        "value":{
            "maxLength":"4000",
            "minLength":"1",
            "pattern":"[a-zA-Z0-9]+",
            "type":"string",
            "description":"Form choice selectbox value for a one specific choice.",
            "example":"1"
        }
    },
    "description":"Form choice item option details"
}

Nested Schema : FormTextItemDto v1.0-allOf[1]

Type: object

Show Source

• maxlength: integer (int32)
  Minimum Value: 0

  Maximum Value: 4000

  Form text item max length

  Example: 4000
• multiline: boolean
  Is form text item multiline

  Example: false

{
    "type":"object",
    "properties":{
        "maxlength":{
            "maximum":"4000",
            "minimum":"0",
            "type":"integer",
            "description":"Form text item max length",
            "format":"int32",
            "example":"4000"
        },
        "multiline":{
            "type":"boolean",
            "description":"Is form text item multiline",
            "example":false
        }
    }
}

Nested Schema : FormDatetimeItemDto v1.0-allOf[1]

Type: object

Show Source

• format: string
  Pattern: YYYY|MON-YYYY|DD-MON-YYYY|DD-MON-YYYY HH:MM

  Date time format

  Example: DD-MON-YYYY

{
    "type":"object",
    "properties":{
        "format":{
            "pattern":"YYYY|MON-YYYY|DD-MON-YYYY|DD-MON-YYYY HH:MM",
            "type":"string",
            "description":"Date time format",
            "example":"DD-MON-YYYY"
        }
    }
}

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