Jump to

• Request
• Response

V1.0

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/unlocks

API unlocks all data records associated with a specific event for a given subject, identified by subject ID and event ID. This endpoint is used to remove event-level locks, enabling updates and modifications for the specified event in the subjects visit or activity schedule within a clinical trial.

Request

Path Parameters

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

  Example:

  E835FACE12345678A1B2C3D4E5F60789

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

  Example:

  test

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

  Example:

  C439E2B3212345678FAB1123FD342871

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

  Example:

  18DFFBDF2523489AAF3DE9D6CA60B7F2

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

DTO representing unlock operation for elements/subjects/visits.

Show Source

• comment: string
  Additional comments about the unlock operation.

  Example: Unlocked due to query resolution
• elements: array elements
  List of Elements to unlock
• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

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

  Example: 2
• lockVisitStartDate: string
  Visit start date for the unlock operation.

  Example: 2023-12-01T12:00:00Z
• reason: string
  Reason information for why the unlock operation is being performed.

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

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

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

  Example: CCBBAA99887766554433221100FFEEDD

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"UUID",
            "example":"DDEEFF112233445566778899AABBCC00"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"UUID",
            "example":"CCBBAA99887766554433221100FFEEDD"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"0112233445566778899AABBCCDDEEFF0"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "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":"int64",
            "example":2
        },
        "lockVisitStartDate":{
            "type":"string",
            "description":"Visit start date for the unlock operation.",
            "example":"2023-12-01T12:00:00Z"
        },
        "elements":{
            "type":"array",
            "description":"List of Elements to unlock",
            "items":{
                "$ref":"#/components/schemas/UnlockElements"
            }
        },
        "reason":{
            "type":"string",
            "description":"Reason information for why the unlock operation is being performed.",
            "example":"Other"
        },
        "comment":{
            "type":"string",
            "description":"Additional comments about the unlock operation.",
            "example":"Unlocked due to query resolution"
        }
    },
    "description":"DTO representing unlock operation for elements/subjects/visits."
}

Nested Schema : elements

Type: array

List of Elements to unlock

Show Source

• Array of: object UnlockElements
  DTO describing a single data element to unlock, such as form, form section, item, or repeat.

{
    "type":"array",
    "description":"List of Elements to unlock",
    "items":{
        "$ref":"#/components/schemas/UnlockElements"
    }
}

Nested Schema : UnlockElements

Type: object

DTO describing a single data element to unlock, such as form, form section, item, or repeat.

Show Source

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

  Example: ABCDEFAB1234567890ABCDEFAB123456
• formSectionId: string (UUID)
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

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

  Example: EFAB1234ABCDEF907890ABCDEFAB1234
• outerRepeat: integer (int64)
  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: 1

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"ABCDEFAB1234567890ABCDEFAB123456"
        },
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "format":"UUID",
            "example":"7890ABCDEFAB1234DEFABC1234567890"
        },
        "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":"int64",
            "example":1
        },
        "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":"int64",
            "example":0
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"UUID",
            "example":"EFAB1234ABCDEF907890ABCDEFAB1234"
        }
    },
    "description":"DTO describing a single data element to unlock, such as form, form section, item, or repeat."
}

Examples

Select an example UnlockDTOExample

Back to Top

Response

Supported Media Types

• application/json

202 Response

Success- empty response body - standard for HTTP 202

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