Jump to

• Request
• Response

V1.0

put

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

Unfreezes a specified data element within a study mode. This endpoint is used to revert a previously frozen data element to a state that allows further data entry or edits. The reason for the unfreeze and a comment must be provided in the request payload.

Request

Path Parameters

• dataElementId(required): string(uuid)
  The unique identifier(UUID, 32-character uppercase hexadecimal string) for the element to be unfrozen given UUID.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

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

  8D05217A464C42E3A10541E44BADE754

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

DTO for unfreezing a data element with reason and comment.

Show Source

• comment: string
  A comment explaining the unfreeze action.

  Example: Requesting unfreeze due to updated laboratory data.
• reasonForChange: string
  A short description explaining the reason for the unfreeze action.

  Example: Data Corrected

{
    "type":"object",
    "properties":{
        "reasonForChange":{
            "type":"string",
            "description":"A short description explaining the reason for the unfreeze action.",
            "example":"Data Corrected"
        },
        "comment":{
            "type":"string",
            "description":"A comment explaining the unfreeze action.",
            "example":"Requesting unfreeze due to updated laboratory data."
        }
    },
    "description":"DTO for unfreezing a data element with reason and comment.",
    "xml":{
        "name":"unfreezeRequest"
    }
}

Examples

Select an example UnFreezeRequestDT02Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Examples

Select an example Empty 200 response

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