REST API for Clinical One Cloud Service

V1.0

put

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

Unfreezes a visit start date. This endpoint is used to revert a previously frozen visit start date to a state that allows further data entry or edits.

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:
```
8D05217A464C42E3A10541E44BADE754
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Superclass for unfreeze requests, contains the reason for unfreezing.

Show Source

comment: string

A short comment explaining for the unfreeze action when Other is selected in reasonForChange

Example: comment
eventId: string (UUID)

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

Example: 7978B7DD0A0A4CA899C485990994300C
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: 3
reasonForChange: string

A short description explaining the reason for the unfreeze action. Accepted values are Change for encoding, Incorrect Subject, Investigator Correction, Transcription Error, Other.

Example: Other
subjectId: string (UUID)

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

Example: AF77C6450BE94DE293C9630142E0AFAD

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"UUID",
            "example":"AF77C6450BE94DE293C9630142E0AFAD"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "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":3
        },
        "comment":{
            "type":"string",
            "description":"A short comment explaining for the unfreeze action when Other is selected in reasonForChange",
            "example":"comment"
        },
        "reasonForChange":{
            "type":"string",
            "description":"A short description explaining the reason for the unfreeze action. Accepted values are Change for encoding, Incorrect Subject, Investigator Correction, Transcription Error, Other.",
            "example":"Other"
        }
    },
    "description":"Superclass for unfreeze requests, contains the reason for unfreezing.",
    "xml":{
        "name":"UnFreezeRequestVSD"
    }
}

Examples

Response

Supported Media Types

application/json

200 Response

Success

400 Response

Bad request.

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