Jump to

• Request
• Response

V1.0

get

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects-with-locked-data

API retrieves a list of all subjects that currently have locked data within a clinical study. This endpoint helps identify subjects whose records are restricted from modification due to data lock actions.

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:

  6020FE17AAC4410B9AB0137E6C88980A

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SubjectWithLockedDataDto

Type: object

DTO representing a response with a list of subject IDs who have locked data.

Show Source

• subjects: array subjects
  List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
            "format":"uuid",
            "example":[
                "A1B23C45D67E89F123456789ABCDEF12",
                "B2C34D56E78F90A123456789ABCDEF34"
            ],
            "items":{
                "type":"string",
                "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
                "format":"uuid"
            }
        }
    },
    "description":"DTO representing a response with a list of subject IDs who have locked data."
}

Nested Schema : subjects

Type: array

List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

Show Source

• Array of: string(uuid)
  List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

{
    "type":"array",
    "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
    "format":"uuid",
    "example":[
        "A1B23C45D67E89F123456789ABCDEF12",
        "B2C34D56E78F90A123456789ABCDEF34"
    ],
    "items":{
        "type":"string",
        "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
        "format":"uuid"
    }
}

Example:

[
    "A1B23C45D67E89F123456789ABCDEF12",
    "B2C34D56E78F90A123456789ABCDEF34"
]

Examples

Select an example SubjectWithLockedDataDtoExample

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