Jump to

• Request
• Response

V1.0

post

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

Freezes the subject-level record and all eligible visit, form, item, repeating, lab, and visit start date freeze records for the supplied subject.

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

Request for freezing all eligible data for one or more subjects.

Show Source

• subjects: array subjects
  Subject identifiers to freeze.

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "description":"Subject identifiers to freeze.",
            "example":[
                "AF77C6450BE94DE293C9630142E0AFAD",
                "F1A1D8A137D74D57937B9F7BEF3A9CC1"
            ],
            "items":{
                "type":"string",
                "description":"Subject identifiers to freeze.",
                "example":"[\"AF77C6450BE94DE293C9630142E0AFAD\",\"F1A1D8A137D74D57937B9F7BEF3A9CC1\"]"
            }
        }
    },
    "description":"Request for freezing all eligible data for one or more subjects.",
    "xml":{
        "name":"subjectFreezeRequest"
    }
}

Nested Schema : subjects

Type: array

Subject identifiers to freeze.

Show Source

• Array of: string
  Subject identifiers to freeze.

  Example: ["AF77C6450BE94DE293C9630142E0AFAD","F1A1D8A137D74D57937B9F7BEF3A9CC1"]

{
    "type":"array",
    "description":"Subject identifiers to freeze.",
    "example":[
        "AF77C6450BE94DE293C9630142E0AFAD",
        "F1A1D8A137D74D57937B9F7BEF3A9CC1"
    ],
    "items":{
        "type":"string",
        "description":"Subject identifiers to freeze.",
        "example":"[\"AF77C6450BE94DE293C9630142E0AFAD\",\"F1A1D8A137D74D57937B9F7BEF3A9CC1\"]"
    }
}

Example:

[
    "AF77C6450BE94DE293C9630142E0AFAD",
    "F1A1D8A137D74D57937B9F7BEF3A9CC1"
]

Examples

Select an example Freeze all eligible data for the supplied subjects

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top