Jump to

• Request
• Response

Get all or specified form items in a study

post

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/formSummaryInfo

Retrieves all or specified latest form items in a study by mode.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

• items: string
• mode(required): string
  Retrieves all form items in a form by mode.

  Allowed Values: [ "test", "training", "active" ]

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: array

Show Source

• Array of: string
  Example: C138D4523012443F93F34CC3F281B675

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"C138D4523012443F93F34CC3F281B675"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Reduced form properties

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

Nested Schema : FormSummaryInfoDto v1.0

Type: object

Title: FormSummaryInfoDto v1.0

Reduced form properties

Show Source

• id: string (uuid)
  Form Unique GUID
• items: array items
• refname: string
  Form refname

  Example: FORM_01
• title: string
  Form title

  Example: Demography

{
    "title":"FormSummaryInfoDto v1.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/FormItemSummaryInfoDtov1"
            }
        }
    },
    "description":"Reduced form properties"
}

Nested Schema : items

Type: array

Show Source

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

  Reduced form item properties

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

Nested Schema : FormItemSummaryInfoDto v1.0

Type: object

Title: FormItemSummaryInfoDto v1.0

Reduced form item properties

Show Source

• id: string (uuid)
  Form Item UUID
• precision: integer (int32)
  Number value precision

  Example: 1
• questionLabel: string
  Form question label

  Example: Age
• questionType: string
  Title: FormItemType

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

  Question type

  Example: numeric
• readOnly: boolean
  Is form item read only?

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

  Example: NUMBER_01
• studyVersion: string
  Study version

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

  List of sub question ids
• units: string
  Units of measure

  Example: kg

{
    "title":"FormItemSummaryInfoDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item UUID",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "subItemIds":{
            "title":"Sub item ids",
            "type":"string",
            "description":"List of sub question ids",
            "format":"uuid"
        },
        "precision":{
            "type":"integer",
            "description":"Number value precision",
            "format":"int32",
            "example":"1"
        },
        "units":{
            "type":"string",
            "description":"Units of measure",
            "example":"kg"
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        }
    },
    "description":"Reduced form item properties"
}

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