REST API for Clinical One Platform

~~[Deprecated]: Get list of forms in a study~~

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Deprecated: Use latest version instead. Retrieves all forms in a study for a specific study version.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E
version(required): string

Study version. Example: "1.0.0.1"
visitid(required): string(uuid)

Visit GUID.

Query Parameters

response(required): string

Response type requested

Default Value: summary

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object FormDto v2.0

Title: FormDto v2.0

Form Info

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

Nested Schema : FormDto v2.0

Type: object

Title: FormDto v2.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 v2.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/FormItemDtoV2"
            }
        }
    },
    "description":"Form Info"
}

Nested Schema : items

Type: array

Show Source

Array of: object FormItemDto v2.0

Title: FormItemDto v2.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }

Form Item Information

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

Nested Schema : FormItemDto v2.0

Type: object

Title: FormItemDto v2.0

Discriminator: questionType

{
    "title":"FormItemDto v2.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/FormDatetimeItemDtoV2",
            "numeric":"#/components/schemas/FormNumberItemDtoV2",
            "measurement":"#/components/schemas/FormNumberItemDtoV2",
            "text":"#/components/schemas/FormTextItemDtoV2",
            "choice":"#/components/schemas/FormChoiceItemDtoV2"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV2"
        }
    ]
}

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 v2.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/FormDatetimeItemDtoV2",
            "numeric":"#/components/schemas/FormNumberItemDtoV2",
            "measurement":"#/components/schemas/FormNumberItemDtoV2",
            "text":"#/components/schemas/FormTextItemDtoV2",
            "choice":"#/components/schemas/FormChoiceItemDtoV2"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV2"
        }
    ]
}

Match One Schema

Show Source

object FormNumberItemDto v2.0

Title: FormNumberItemDto v2.0

Form Number Item Details Information
object FormChoiceItemDto v2.0

Title: FormChoiceItemDto v2.0

Form Choice Item Details Information
object FormTextItemDto v2.0

Title: FormTextItemDto v2.0

Form text Item Details Information
object FormDatetimeItemDto v2.0

Title: FormDatetimeItemDto v2.0

Form DateTime Item Details Information

{
    "title":"FormItemDto v2.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/FormDatetimeItemDtoV2",
            "numeric":"#/components/schemas/FormNumberItemDtoV2",
            "measurement":"#/components/schemas/FormNumberItemDtoV2",
            "text":"#/components/schemas/FormTextItemDtoV2",
            "choice":"#/components/schemas/FormChoiceItemDtoV2"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtoV2"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtoV2"
        }
    ]
}

Nested Schema : FormNumberItemDto v2.0

Type: object

Title: FormNumberItemDto v2.0

Form Number Item Details Information

Match All

Form Number Item Details Information

Show Source

object FormItemDto v2.0

Title: FormItemDto v2.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }

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

{
    "title":"FormNumberItemDto v2.0",
    "required":[
        "precision",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Number Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV2"
        },
        {
            "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 v2.0

Type: object

Title: FormChoiceItemDto v2.0

Form Choice Item Details Information

Match All

Form Choice Item Details Information

Show Source

object FormItemDto v2.0

Title: FormItemDto v2.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }

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

{
    "title":"FormChoiceItemDto v2.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Choice Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV2"
        },
        {
            "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/FormOptionDtoV2"
                    }
                }
            }
        }
    ]
}

Nested Schema : FormTextItemDto v2.0

Type: object

Title: FormTextItemDto v2.0

Form text Item Details Information

Match All

Form text Item Details Information

Show Source

object FormItemDto v2.0

Title: FormItemDto v2.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }

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

{
    "title":"FormTextItemDto v2.0",
    "required":[
        "maxlength",
        "multiline",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form text Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV2"
        },
        {
            "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 v2.0

Type: object

Title: FormDatetimeItemDto v2.0

Form DateTime Item Details Information

Match All

Form DateTime Item Details Information

Show Source

object FormItemDto v2.0

Title: FormItemDto v2.0

Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtoV2", "numeric":"#/components/schemas/FormNumberItemDtoV2", "measurement":"#/components/schemas/FormNumberItemDtoV2", "text":"#/components/schemas/FormTextItemDtoV2", "choice":"#/components/schemas/FormChoiceItemDtoV2" } }

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

{
    "title":"FormDatetimeItemDto v2.0",
    "required":[
        "format",
        "questionLabel",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form DateTime Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtoV2"
        },
        {
            "type":"object",
            "properties":{
                "format":{
                    "pattern":"yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm",
                    "type":"string",
                    "description":"Date time format",
                    "example":"DD-MON-YYYY"
                },
                "allowPartialDate":{
                    "maximum":1,
                    "minimum":0,
                    "type":"integer",
                    "description":"Allow partial date",
                    "format":"int32",
                    "example":1
                },
                "partialDate":{
                    "pattern":"yyyy|MMM-yyyy",
                    "type":"string",
                    "description":"Partial date format",
                    "example":"MMM-yyyy"
                }
            }
        }
    ]
}

Nested Schema : FormNumberItemDto v2.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 v2.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/FormOptionDtoV2"
            }
        }
    }
}

Nested Schema : options

Type: array

Show Source

Array of: object FormOptionDto v2.0

Title: FormOptionDto v2.0

Form choice item option details

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

Nested Schema : FormOptionDto v2.0

Type: object

Title: FormOptionDto v2.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 v2.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 v2.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 v2.0-allOf[1]

Type: object

Show Source

allowPartialDate: integer (int32)

Minimum Value: 0

Maximum Value: 1

Allow partial date

Example: 1
format: string

Pattern: yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm

Date time format

Example: DD-MON-YYYY
partialDate: string

Pattern: yyyy|MMM-yyyy

Partial date format

Example: MMM-yyyy

{
    "type":"object",
    "properties":{
        "format":{
            "pattern":"yyyy|MMM-yyyy|dd-MMM-yyyy|dd-MMM-yyyy HH:mm",
            "type":"string",
            "description":"Date time format",
            "example":"DD-MON-YYYY"
        },
        "allowPartialDate":{
            "maximum":1,
            "minimum":0,
            "type":"integer",
            "description":"Allow partial date",
            "format":"int32",
            "example":1
        },
        "partialDate":{
            "pattern":"yyyy|MMM-yyyy",
            "type":"string",
            "description":"Partial date format",
            "example":"MMM-yyyy"
        }
    }
}

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.