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

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