Jump to

• Request
• Response

v2.0

put

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

Retrieves a list of form statuses, form completion, form last update and form start for the given form IDs. Differences from v1 version of API: Base path updated to v2.0. Request body also includes usePersistence flag to control persistence usage. Response upgraded to include metadata timestamps formStart, formCompletion, formLastUpdate for repeat level (outerRepeat and innerRepeat both are not-null for repeat level) and instance level (inner repeat is null and outer repeat is not null for instance level) of a form.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  3F2504E04F8911D39A0C0305E82C3301

• subjectId(required): string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  10F75668189F422F9A461A315D211111

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Contains a list of form entries used to request form status for a subject.

Show Source

• formDetails: array formDetails
  List of form entries for which status is requested.

{
    "type":"object",
    "properties":{
        "formDetails":{
            "type":"array",
            "description":"List of form entries for which status is requested.",
            "items":{
                "$ref":"#/components/schemas/FormDetails2"
            }
        }
    },
    "description":"Contains a list of form entries used to request form status for a subject."
}

Nested Schema : formDetails

Type: array

List of form entries for which status is requested.

Show Source

• Array of: object FormDetails2
  Represents filter criteria for a single form entry including event, form, event instance number and persistence usage flag.

{
    "type":"array",
    "description":"List of form entries for which status is requested.",
    "items":{
        "$ref":"#/components/schemas/FormDetails2"
    }
}

Nested Schema : FormDetails2

Type: object

Represents filter criteria for a single form entry including event, form, event instance number and persistence usage flag.

Show Source

• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: ADF5A7800A954FA5B831E7B6B9CA39A9
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• usePersistence: boolean
  Indicates whether persisted cached values should be used when computing status, by default the flag is false

  Example: false

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "usePersistence":{
            "type":"boolean",
            "description":"Indicates whether persisted cached values should be used when computing status, by default the flag is false",
            "example":false
        }
    },
    "description":"Represents filter criteria for a single form entry including event, form, event instance number and persistence usage flag."
}

Examples

Select an example FormDetailsRequestDto2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormStatusDto2
  Extends FormStatusDto with inner repeat and timestamps for form start, completion and last update. All timestamps are in UTC.

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

Nested Schema : FormStatusDto2

Type: object

Extends FormStatusDto with inner repeat and timestamps for form start, completion and last update. All timestamps are in UTC.

Show Source

• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: ADF5A7800A954FA5B831E7B6B9CA39A9
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• formCompletion: string (date-time)
  Form completion timestamp.

  Example: 2025-10-16T14:30:31.892Z
• formCompletion3: string (date-time)
  Form completion timestamp based on latest computation in this version.

  Example: 2025-10-16T14:30:31.892Z
• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• formLastUpdate: string (date-time)
  Form last update timestamp.

  Example: 2025-10-16T14:30:31.892Z
• formLastUpdate3: string (date-time)
  Form last update timestamp based on latest computation in this version.

  Example: 2025-10-16T14:30:31.892Z
• formStart: string (date-time)
  Form start timestamp.

  Example: 2025-10-16T14:30:31.892Z
• formStart3: string (date-time)
  Form start timestamp based on latest computation in this version.

  Example: 2025-10-16T14:30:31.892Z
• formStatus: string
  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
• innerRepeat: integer (int32)
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example: 0
• outerRepeat: integer (int32)
  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

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "outerRepeat":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":0
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "formStatus":{
            "type":"string",
            "description":"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"
        },
        "innerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.",
            "format":"int32",
            "example":0
        },
        "formStart3":{
            "type":"string",
            "description":"Form start timestamp based on latest computation in this version.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "formCompletion3":{
            "type":"string",
            "description":"Form completion timestamp based on latest computation in this version.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "formLastUpdate3":{
            "type":"string",
            "description":"Form last update timestamp based on latest computation in this version.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "formStart":{
            "type":"string",
            "description":"Form start timestamp.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "formCompletion":{
            "type":"string",
            "description":"Form completion timestamp.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "formLastUpdate":{
            "type":"string",
            "description":"Form last update timestamp.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        }
    },
    "description":"Extends FormStatusDto with inner repeat and timestamps for form start, completion and last update. All timestamps are in UTC."
}

Examples

Select an example FormStatusResponse

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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