Jump to

• Request
• Response

v1.0

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lock/subjects

Retrieves latest lock status for all subjects under a study.

Request

Path Parameters

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

  Example:

  active

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

  Example:

  A1B2C3D4E5F647839ABCDEF012345678

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  number of records

  Default Value: 5000

  Example:

  5000

• offset: integer(int32)
  Minimum Value: 0

  starting offset

  Example:

  0

• order: string
  asc or desc

  Default Value: DESC

  Example:

  DESC

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

  Example:

  E3E70682E5F7473E8D39BB0D7B1A3B52

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LockedStatusDTO

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

Nested Schema : LockedStatusDTO

Type: object

Show Source

• action: string
  Action taken on the visit start date value.Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.

  Example: LOCKED
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comment or note about the action.

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

  Example: D4E5F6A1B2C347839ABCDEF012345678
• eventInstanceNum: integer (int)
  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: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• formSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: ABCDEF12ABCDEF12ABCDEF12ABCDEF12
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• innerRepeat: integer (int)
  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
• itemId: string
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: 0F1E2D3C4B5A69788796A5B4C3D2E1F0
• objectVersionNumber: number
  Object version number used for concurrency control.

  Example: 1
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: MODIFIED
• outerRepeat: integer (int)
  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
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the lock or action.

  Example: Site audit lock
• repeatFormNumber: integer (int)
  Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

  Example: 0
• repeatSequenceNumber: integer (int)
  Internal repeat sequence number for item or visit repeats.

  Example: 0
• siteID: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: 938D23FA6B7241CCA41BD627E5DB60DA
• softwareVersionNumber: number
  Software version number used when the record was generated.

  Example: 300
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

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

  Example: A1B2C3D4E5F647839ABCDEF012345678
• userId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user

  Example: 225B79C982104415886DE02BC73C1E1E
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2023-01-01T10:00:00Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2023-01-01T09:00:00Z
• visitStartDateAction: string
  Action to be taken for the visit. The value may be SCREEN_ENABLE, SCREEN_DISABLE, RANDOMIZE_ENABLE, RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE and COMPLETE_STUDY_DISABLE.

  Example: COMPLETE_STUDY_DISABLE

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string)  representing the record.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-01-01T10:00:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "example":"225B79C982104415886DE02BC73C1E1E"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control.",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number used when the record was generated.",
            "example":300
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the lock or action.",
            "example":"Site audit lock"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment or note about the action.",
            "example":"Locked by monitor for review"
        },
        "siteID":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"938D23FA6B7241CCA41BD627E5DB60DA"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"A1B2C3D4E5F647839ABCDEF012345678"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"D4E5F6A1B2C347839ABCDEF012345678"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Internal repeat sequence number for item or visit repeats.",
            "format":"int",
            "example":0
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"0F1E2D3C4B5A69788796A5B4C3D2E1F0"
        },
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"ABCDEF12ABCDEF12ABCDEF12ABCDEF12"
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
            "format":"int",
            "example":0
        },
        "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":"int",
            "example":0
        },
        "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":"int",
            "example":0
        },
        "action":{
            "type":"string",
            "description":"Action taken on the visit start date value.Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.",
            "example":"LOCKED"
        },
        "visitStartDateAction":{
            "type":"string",
            "description":"Action to be taken for the visit. The value may be SCREEN_ENABLE, SCREEN_DISABLE, RANDOMIZE_ENABLE, RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE and COMPLETE_STUDY_DISABLE.",
            "example":"COMPLETE_STUDY_DISABLE"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.3"
        },
        "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":"int",
            "example":1
        }
    }
}

Examples

Select an example LockedStatusList

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