Jump to

• Request
• Response

V1.0

post

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

Returns lab-normal tagged form items for selected study-version forms. The request body must identify the study versions and form IDs to inspect; the response groups matching lab-normal items by study version and form.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• excludeItemType: string
  Form item type to exclude from returned item details.

  Allowed Values: [ "instructionalText" ]

  Example:

  instructionalText

• formCategory: string
  Form category filter.

  Default Value: ALL

  Allowed Values: [ "DCS", "NSF", "ALL" ]

  Example:

  ALL

• mode(required): string
  Study mode filter.

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

  Example:

  test

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object CopyForms
  Title: CopyForms

  Information about forms to be copied.

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

Nested Schema : CopyForms

Type: object

Title: CopyForms

Information about forms to be copied.

Show Source

• formId(required): string (uuid)
  Form GUID
• studyId(required): string (uuid)
  Study GUID
• version(required): string
  version

  Example: 1.3.0.6

{
    "title":"CopyForms",
    "required":[
        "formId",
        "studyId",
        "version"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        }
    },
    "description":"Information about forms to be copied."
}

Examples

Select an example labNormalFormItemsRequestV1

Back to Top

Response

Supported Media Types

• application/json

200 Response

Lab-normal form items were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RespLabNormalFormItemsDto

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

Nested Schema : RespLabNormalFormItemsDto

Type: object

Show Source

• forms: object LabNormalFormDto v1.0
  Title: LabNormalFormDto v1.0

  LabNormal Form Detail Information
• studyVersion: string
  Study Version

  Example: 1.0.0.1

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string",
            "description":"Study Version",
            "example":"1.0.0.1"
        },
        "forms":{
            "title":"LabNormalFormDto v1.0",
            "type":"object",
            "properties":{
                "formId":{
                    "type":"string",
                    "description":"Form Id",
                    "format":"uuid"
                },
                "items":{
                    "title":"LabNormalItemDto v1.0",
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"Item Id",
                            "format":"uuid"
                        },
                        "refname":{
                            "type":"string",
                            "description":"Form refname",
                            "example":"FORM_01"
                        },
                        "formId":{
                            "type":"string",
                            "description":"Form Id",
                            "format":"uuid"
                        },
                        "format":{
                            "type":"string",
                            "description":"Date Format",
                            "example":"dd-MMM-yyyy"
                        },
                        "labNormalsTag":{
                            "type":"string",
                            "description":"labNormalsTag",
                            "example":"Race"
                        },
                        "options":{
                            "title":"FormOptionDto v17.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,
                                    "type":"string",
                                    "description":"Form choice selectbox value for a one specific choice.",
                                    "example":"1"
                                },
                                "clCode":{
                                    "type":"string",
                                    "description":"Codelist code for a one specific choice.",
                                    "example":"1"
                                },
                                "clDescription":{
                                    "maxLength":4000,
                                    "minLength":1,
                                    "type":"string",
                                    "description":"Codelist description for a one specific choice.",
                                    "example":"1"
                                },
                                "clValue":{
                                    "type":"string",
                                    "description":"Codelist value for a one specific choice.",
                                    "example":"1"
                                }
                            },
                            "description":"Form choice item option details"
                        }
                    },
                    "description":"Item tagged with labNormalTag Details"
                }
            },
            "description":"LabNormal Form Detail Information"
        }
    }
}

Nested Schema : LabNormalFormDto v1.0

Type: object

Title: LabNormalFormDto v1.0

LabNormal Form Detail Information

Show Source

• formId: string (uuid)
  Form Id
• items: object LabNormalItemDto v1.0
  Title: LabNormalItemDto v1.0

  Item tagged with labNormalTag Details

{
    "title":"LabNormalFormDto v1.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form Id",
            "format":"uuid"
        },
        "items":{
            "title":"LabNormalItemDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Item Id",
                    "format":"uuid"
                },
                "refname":{
                    "type":"string",
                    "description":"Form refname",
                    "example":"FORM_01"
                },
                "formId":{
                    "type":"string",
                    "description":"Form Id",
                    "format":"uuid"
                },
                "format":{
                    "type":"string",
                    "description":"Date Format",
                    "example":"dd-MMM-yyyy"
                },
                "labNormalsTag":{
                    "type":"string",
                    "description":"labNormalsTag",
                    "example":"Race"
                },
                "options":{
                    "title":"FormOptionDto v17.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,
                            "type":"string",
                            "description":"Form choice selectbox value for a one specific choice.",
                            "example":"1"
                        },
                        "clCode":{
                            "type":"string",
                            "description":"Codelist code for a one specific choice.",
                            "example":"1"
                        },
                        "clDescription":{
                            "maxLength":4000,
                            "minLength":1,
                            "type":"string",
                            "description":"Codelist description for a one specific choice.",
                            "example":"1"
                        },
                        "clValue":{
                            "type":"string",
                            "description":"Codelist value for a one specific choice.",
                            "example":"1"
                        }
                    },
                    "description":"Form choice item option details"
                }
            },
            "description":"Item tagged with labNormalTag Details"
        }
    },
    "description":"LabNormal Form Detail Information"
}

Nested Schema : LabNormalItemDto v1.0

Type: object

Title: LabNormalItemDto v1.0

Item tagged with labNormalTag Details

Show Source

• format: string
  Date Format

  Example: dd-MMM-yyyy
• formId: string (uuid)
  Form Id
• id: string (uuid)
  Item Id
• labNormalsTag: string
  labNormalsTag

  Example: Race
• options: object FormOptionDto v17.0
  Title: FormOptionDto v17.0

  Form choice item option details
• refname: string
  Form refname

  Example: FORM_01

{
    "title":"LabNormalItemDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Item Id",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "formId":{
            "type":"string",
            "description":"Form Id",
            "format":"uuid"
        },
        "format":{
            "type":"string",
            "description":"Date Format",
            "example":"dd-MMM-yyyy"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"labNormalsTag",
            "example":"Race"
        },
        "options":{
            "title":"FormOptionDto v17.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,
                    "type":"string",
                    "description":"Form choice selectbox value for a one specific choice.",
                    "example":"1"
                },
                "clCode":{
                    "type":"string",
                    "description":"Codelist code for a one specific choice.",
                    "example":"1"
                },
                "clDescription":{
                    "maxLength":4000,
                    "minLength":1,
                    "type":"string",
                    "description":"Codelist description for a one specific choice.",
                    "example":"1"
                },
                "clValue":{
                    "type":"string",
                    "description":"Codelist value for a one specific choice.",
                    "example":"1"
                }
            },
            "description":"Form choice item option details"
        }
    },
    "description":"Item tagged with labNormalTag Details"
}

Nested Schema : FormOptionDto v17.0

Type: object

Title: FormOptionDto v17.0

Form choice item option details

Show Source

• clCode: string
  Codelist code for a one specific choice.

  Example: 1
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description for a one specific choice.

  Example: 1
• clValue: string
  Codelist value for a one specific choice.

  Example: 1
• 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

  Form choice selectbox value for a one specific choice.

  Example: 1

{
    "title":"FormOptionDto v17.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,
            "type":"string",
            "description":"Form choice selectbox value for a one specific choice.",
            "example":"1"
        },
        "clCode":{
            "type":"string",
            "description":"Codelist code for a one specific choice.",
            "example":"1"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Codelist description for a one specific choice.",
            "example":"1"
        },
        "clValue":{
            "type":"string",
            "description":"Codelist value for a one specific choice.",
            "example":"1"
        }
    },
    "description":"Form choice item option details"
}

Examples

Select an example labNormalFormItemsResponseV1

400 Response

The request payload is missing studyVersion or formId, or contains invalid values.

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 badRequest

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