1. REST API for Clinical One Platform
  2. Tasks
  3. Data Integration
  4. Data Elements
  5. Get form details for a given Form ID

v1.0

put

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/formStatus

This endpoint retrieves the status of forms associated with a specific subject in a study. It requires the study ID, subject ID, and a list of form details to fetch the status for. The response includes the form status for each form specified in the request.

Request

Path Parameters
  • Mode of the study, accepts: test, active, or training.
    Example:
    test
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example:
    ABCDEF1234567890ABCDEF1234567890
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example:
    10F75668189F422F9A461A315D211111
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request DTO containing a list of form filters used to retrieve form status for a subject. Each entry specifies eventId, formId and optionally eventInstanceNum.
Show Source
Nested Schema : formDetails
Type: array
List of form details specifying event, form and instance filters
Show Source
Example:
[
    {
        "eventId":"ADF5A7800A954FA5B831E7B6B9CA39A9",
        "formId":"40DB4EF4847849CCB24EFCCB71CDA436",
        "eventInstanceNum":1
    }
]
Nested Schema : FormDetails
Type: object
Represents filter criteria for a single form entry including event, form and event instance number
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: ADF5A7800A954FA5B831E7B6B9CA39A9
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
Example:
[
    {
        "eventId":"ADF5A7800A954FA5B831E7B6B9CA39A9",
        "formId":"40DB4EF4847849CCB24EFCCB71CDA436",
        "eventInstanceNum":1
    }
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : FormStatusDto
Type: object
Represents the status of a form for a given event and instance including outer repeat and event instance number.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: ADF5A7800A954FA5B831E7B6B9CA39A9
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • Status of the form. Status can be NEW, OPTIONAL, COMPLETED, COMPLETED_WITH_ERROR, IN_PROGRESS, IN_PROGRESS_WITH_ERROR, INCOMPLETE, INCOMPLETE_WITH_ERROR or DELETED.
    Example: COMPLETED
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 0
Examples

400 Response

Bad request.
Body ()
Root Schema : RestResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId
Back to Top