Jump to

• Request
• Response

V2.0

get

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

Returns reduced form and item summaries for the requested study mode. Compared with v1.0, this version uses the v19 summary mapping for the response while keeping the same study ID and mode inputs.

Request

Path Parameters

• mode(required): string
  Study mode path segment. Required. Allowed values: test, training, active.
• studyId(required): string
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.
• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Form and item summaries returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RespStudyAllFormsDto

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

Nested Schema : RespStudyAllFormsDto

Type: object

Show Source

• formId: string (uuid)
  Form Unique GUID
• items: array items

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Study All Forms And Item Type DTO V1"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

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

  Reduced form item properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Study All Forms And Item Type DTO V1"
    }
}

Nested Schema : StudyAllFormsItemsTypeDto v1.0

Type: object

Title: StudyAllFormsItemsTypeDto v1.0

Reduced form item properties

Show Source

• id: string (uuid)
  Form Item Unique GUID
• questionType: string
  Title: FormItemType

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

  Question type

  Example: numeric

{
    "title":"StudyAllFormsItemsTypeDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        }
    },
    "description":"Reduced form item properties"
}

Examples

Select an example formItemsSummaryResponseV2

500 Response

Error

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"
}

Examples

Select an example serverError

Back to Top