Jump to

• Request
• Response

V3.0

get

/ec-designer-svc/rest/v3.0/studies/{studyId}/{mode}/forms

Retrieves a list of forms in a study.

Request

Path Parameters

• mode(required): string
  Study mode to filter study forms.

  Example:

  test

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• excludeItemType: string
  Form Item type to exclude from response Optional.

  Allowed Values: [ "instructionalText" ]

  Example:

  instructionalText

• formCategory: string
  Return forms with this Form Category. Optional.

  Default Value: DCS

  Example:

  DCS

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 FormSummaryDto v3.0
  Title: FormSummaryDto v3.0

  Reduced form properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Form Summary DTO V3"
    }
}

Nested Schema : FormSummaryDto v3.0

Type: object

Title: FormSummaryDto v3.0

Reduced form properties

Show Source

• formCategory: string
  Form category

  Example: DCS
• formSubcategory: array formSubcategory
  Form subcategory list
• id: string (uuid)
  Form Unique GUID
• items: array items
• refname: string
  Form refname

  Example: FORM_01
• title: string
  Form title

  Example: Demography

{
    "title":"FormSummaryDto v3.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "title":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Form Item Summary DTO V3"
            }
        },
        "formCategory":{
            "type":"string",
            "description":"Form category",
            "example":"DCS"
        },
        "formSubcategory":{
            "type":"array",
            "description":"Form subcategory list",
            "items":{
                "type":"string",
                "description":"Form subcategory list"
            }
        }
    },
    "description":"Reduced form properties"
}

Nested Schema : formSubcategory

Type: array

Form subcategory list

Show Source

• Array of: string
  Form subcategory list

{
    "type":"array",
    "description":"Form subcategory list",
    "items":{
        "type":"string",
        "description":"Form subcategory list"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object FormItemSummaryDto v3.0
  Title: FormItemSummaryDto v3.0

  Reduced form item properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Form Item Summary DTO V3"
    }
}

Nested Schema : FormItemSummaryDto v3.0

Type: object

Title: FormItemSummaryDto v3.0

Reduced form item properties

Show Source

• id: string (uuid)
  Form Item Unique GUID
• questionLabel: string
  Form question label

  Example: Age
• questionType: string
  Title: FormItemType

  Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]

  Question type

  Example: numeric
• refname: string
  Form item reference name.

  Example: NUMBER_01
• subItemIds: string (uuid)
  Title: Sub item ids

  List of sub question ids

{
    "title":"FormItemSummaryDto v3.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "subItemIds":{
            "title":"Sub item ids",
            "type":"string",
            "description":"List of sub question ids",
            "format":"uuid"
        }
    },
    "description":"Reduced form item properties"
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

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