Forms endpoint

Given a StudyKey, fetch the set of forms. A form is a design resource that represents an electronic clinical case report form (eCRF). A single form contains many questions. It is related to records in that each record is a single instance of a form for a given subject.

Accessing the index

A GET request is used to access the index

Request structure

GET /api/v1/edc/studies/PHARMADEMO/forms?page=0&size=25&sort=formId%2CASC&filter=formId%3D%3D10265 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

Path parameters are required.

Table 1. /api/v1/edc/studies/{studyKey}/forms
Parameter Description

studyKey

StudyKey to retrieve list of forms

Request parameters

Request parameters are optional. Default values are used unless specified.

Parameter Description

page

Which index page to be returned. Default value is 0.

size

Items per page to be returned. Default value is 25. Maximum items allowed per page is 500

sort

Name of the property by which to sort the result set. To sort in a particular direction add a comma to the property name and either asc or desc. To sort by multiple properties add additional sort parameters. Default value is formId,asc.

filter

Optional filter search criteria. Must follow correct syntax. Refer to filter section for details.

Response body

Below is an example response payload.

{
  "metadata" : {
    "status" : "OK",
    "method" : "GET",
    "path" : "/api/v1/edc/studies/PHARMADEMO/forms",
    "timestamp" : "2023-12-27 22:15:16",
    "error" : { }
  },
  "pagination" : {
    "currentPage" : 0,
    "size" : 25,
    "totalPages" : 1,
    "totalElements" : 1,
    "sort" : [ {
      "property" : "formId",
      "direction" : "ASC"
    } ]
  },
  "data" : [ {
    "studyKey" : "PHARMADEMO",
    "formId" : 1,
    "formKey" : "FORM_1",
    "formName" : "Mock Form 1",
    "formType" : "Subject",
    "revision" : 1,
    "embeddedLog" : false,
    "enforceOwnership" : false,
    "userAgreement" : false,
    "subjectRecordReport" : false,
    "unscheduledVisit" : false,
    "otherForms" : false,
    "eproForm" : false,
    "allowCopy" : true,
    "disabled" : false,
    "dateCreated" : "2023-12-27 22:15:16",
    "dateModified" : "2023-12-27 22:15:17"
  } ]
}

Response fields

Path Type Description

metadata.status

String

Http status

metadata.method

String

Http method

metadata.path

String

Requested URI path

metadata.timestamp

String

Timestamp when response was generated

metadata.error

Object

Detail error message from request if error occur

pagination.currentPage

Number

Current index page

pagination.size

Number

Size per page

pagination.totalPages

Number

Total pages return from search

pagination.totalElements

Number

Total elements return from search

pagination.sort[].property

String

Sort property

pagination.sort[].direction

String

Sort direction

data[].studyKey

String

Unique study key for a given study

data[].formId

Number

Mednet Form ID

data[].formKey

String

Form key

data[].formName

String

Name of the eCRF

data[].formType

String

eCRF Type. For example: Subject/Site

data[].revision

Number

Number of modifications of the form metadata

data[].embeddedLog

Boolean

Embedded Log checkbox value on the form attributes

data[].enforceOwnership

Boolean

Enforce Ownership checkbox value on the form attributes

data[].userAgreement

Boolean

User Agreement checkbox value on the form attributes

data[].subjectRecordReport

Boolean

Subject Record Report checkbox value on the form attributes

data[].unscheduledVisit

Boolean

Include in Unscheduled Visits checkbox value on the form attributes

data[].otherForms

Boolean

Include in Other Forms checkbox value on the form attributes

data[].eproForm

Boolean

Is ePRO checkbox value on the form attributes

data[].allowCopy

Boolean

Allow Copy checkbox value on the form attributes

data[].disabled

Boolean

Form is soft delete status

data[].dateCreated

String

Date when this form was created

data[].dateModified

String

Date when this form was last modified