Jump to

• Request
• Response

[Deprecated]: V2.0

get

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

Deprecated: Use latest version instead. Retrieves the forms available in a study for the selected mode. The response includes each form's ID, reference name, title, and summary item details when item details are available. Use excludeItemType to omit instructional text items from the returned item summaries.

Request

Path Parameters

• mode(required): string
  Study mode used to return forms. Allowed values: test, training, active.

  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
  Optional form item type to exclude from returned item summaries.

  Allowed Values: [ "instructionalText" ]

  Example:

  instructionalText

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

  Summary information for a study form returned by the V2.0 query forms API.

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

Nested Schema : FormSummaryDto v2.0

Type: object

Title: FormSummaryDto v2.0

Summary information for a study form returned by the V2.0 query forms API.

Show Source

• id: string (uuid)
  Form ID. UUID, 32-character uppercase hexadecimal string.
• items: array items
  Form item summaries.
• refname: string
  Reference name for the form.

  Example: DEMOGRAPHICS
• title: string
  Display title for the form.

  Example: Demographics

{
    "title":"FormSummaryDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Reference name for the form.",
            "example":"DEMOGRAPHICS"
        },
        "title":{
            "type":"string",
            "description":"Display title for the form.",
            "example":"Demographics"
        },
        "items":{
            "type":"array",
            "description":"Form item summaries.",
            "example":[
                {
                    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                    "refname":"AGE",
                    "questionType":"numeric",
                    "questionLabel":"Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemSummaryDTOV2"
            }
        }
    },
    "description":"Summary information for a study form returned by the V2.0 query forms API.",
    "example":{
        "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "refname":"DEMOGRAPHICS",
        "title":"Demographics",
        "items":[
            {
                "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                "refname":"AGE",
                "questionType":"numeric",
                "questionLabel":"Age"
            }
        ]
    }
}

Example:

{
    "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "refname":"DEMOGRAPHICS",
    "title":"Demographics",
    "items":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ]
}

Nested Schema : items

Type: array

Form item summaries.

Show Source

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

  Summary information for a form item returned by the V2.0 query forms API.

{
    "type":"array",
    "description":"Form item summaries.",
    "example":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemSummaryDTOV2"
    }
}

Example:

[
    {
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "refname":"AGE",
        "questionType":"numeric",
        "questionLabel":"Age"
    }
]

Nested Schema : FormItemSummaryDto v2.0

Type: object

Title: FormItemSummaryDto v2.0

Summary information for a form item returned by the V2.0 query forms API.

Show Source

• id: string (uuid)
  Form item ID. UUID, 32-character uppercase hexadecimal string.
• questionLabel: string
  Display label for the question.

  Example: Age
• questionType: string
  Title: FormItemType

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

  Question type for the form item.

  Example: numeric
• refname: string
  Reference name for the form item.

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

  IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.

{
    "title":"FormItemSummaryDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form item ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Reference name for the form item.",
            "example":"AGE"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type for the form item.",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Display label for the question.",
            "example":"Age"
        },
        "subItemIds":{
            "title":"Sub item ids",
            "type":"string",
            "description":"IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        }
    },
    "description":"Summary information for a form item returned by the V2.0 query forms API.",
    "example":{
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "refname":"AGE",
        "questionType":"numeric",
        "questionLabel":"Age"
    }
}

Example:

{
    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
    "refname":"AGE",
    "questionType":"numeric",
    "questionLabel":"Age"
}

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

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top