Jump to

• Request
• Response

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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  8D05217A464C42E3A10541E44BADE754

Supported Media Types

• application/json

Request Body - 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) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 7978B7DD0A0A4CA899C485990994300C
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). 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 identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: AF77C6450BE94DE293C9630142E0AFAD

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"AF77C6450BE94DE293C9630142E0AFAD"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). 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

Select an example UnFreezeRequestVSDExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top