Jump to

• Request
• Response

V1.0

post

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

API unlocks all visit records associated with the specified subject, based on the provided subject ID. This endpoint is used to remove visit-level locks, allowing updates and data entry for all visits of the selected subject within a clinical study.

Request

Path Parameters

• 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:

  A834DE46BBFA4737B98EFF1087A26DEA

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

  Example:

  A8BAB123BAC4410B9AB0137E6C889821

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Unlock DTO for unlocking all visits/items for a subject, except subject-level. All fields are optional.

Show Source

• comment: string
  Additional comment or context for the unlock request.

  Example: Unlocking all visits except main subject lock due to CRA request.
• reason: string
  Reason for requesting this unlock.

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

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

  Example: 91d1b34ed1904d8499844159776b2fd7

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"UUID",
            "example":"b123fe17aac4410b9ab0137e6c88981a"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "format":"UUID",
            "example":"91d1b34ed1904d8499844159776b2fd7"
        },
        "reason":{
            "type":"string",
            "description":"Reason for requesting this unlock.",
            "example":"Other."
        },
        "comment":{
            "type":"string",
            "description":"Additional comment or context for the unlock request.",
            "example":"Unlocking all visits except main subject lock due to CRA request."
        }
    },
    "description":"Unlock DTO for unlocking all visits/items for a subject, except subject-level. All fields are optional."
}

Examples

Select an example UnlockDto Example

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted - unlock starts (no response body for this API).

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