Jump to

• Request
• Response

V1.0

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/visits/lock

API is used to lock list of subjects, visits, forms, and items within a clinical study.

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:

  0727DC1B0BA64C8482B9F5E1226C3A71

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

DTO representing a subject and the list of events (visits/forms/items) to be locked.

Show Source

• events: array events
  List of visit/form/item objects for the subject in UUID format.
• subjectId: string (UUID)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: F5F6EA48B9D04C6F8C657CFA5A20EC53

{
    "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":"F5F6EA48B9D04C6F8C657CFA5A20EC53"
        },
        "events":{
            "type":"array",
            "description":"List of visit/form/item objects for the subject in UUID format.",
            "items":{
                "$ref":"#/components/schemas/VisitFormsItemsDTO"
            }
        }
    },
    "description":"DTO representing a subject and the list of events (visits/forms/items) to be locked."
}

Nested Schema : events

Type: array

List of visit/form/item objects for the subject in UUID format.

Show Source

• Array of: object VisitFormsItemsDTO
  DTO for event (visit) details including forms and items to be locked.

{
    "type":"array",
    "description":"List of visit/form/item objects for the subject in UUID format.",
    "items":{
        "$ref":"#/components/schemas/VisitFormsItemsDTO"
    }
}

Nested Schema : VisitFormsItemsDTO

Type: object

DTO for event (visit) details including forms and items to be locked.

Show Source

• elements: array elements
  List of data element DTOs indicating forms/items under the visit.
• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: BCAF12ED87549BA59F7A43AB6A77C1E2
• eventInstanceNum: integer (int64)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 2.0.0.38

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"BCAF12ED87549BA59F7A43AB6A77C1E2"
        },
        "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":"int64",
            "example":1
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "elements":{
            "type":"array",
            "description":"List of data element DTOs indicating forms/items under the visit.",
            "items":{
                "$ref":"#/components/schemas/DataElementRequestDTO"
            }
        }
    },
    "description":"DTO for event (visit) details including forms and items to be locked."
}

Nested Schema : elements

Type: array

List of data element DTOs indicating forms/items under the visit.

Show Source

• Array of: object DataElementRequestDTO
  DTO specifying a data elements (form, form section, item, or repeat) to be locked or unlocked in a visit.

{
    "type":"array",
    "description":"List of data element DTOs indicating forms/items under the visit.",
    "items":{
        "$ref":"#/components/schemas/DataElementRequestDTO"
    }
}

Nested Schema : DataElementRequestDTO

Type: object

DTO specifying a data elements (form, form section, item, or repeat) to be locked or unlocked in a visit.

Show Source

• formId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: AABBCCDDEEFF00112233445566778899
• formSectionId: string (UUID)
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: BB112233445566778899AABBCCDDEEFF
• innerRepeat: integer (int64)
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example: 0
• itemId: string (UUID)
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: EEFF00112233445566778899AABBCCDD
• outerRepeat: integer (int64)
  Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.

  Example: 1

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"AABBCCDDEEFF00112233445566778899"
        },
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "format":"UUID",
            "example":"BB112233445566778899AABBCCDDEEFF"
        },
        "innerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.",
            "format":"int64",
            "example":0
        },
        "outerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.",
            "format":"int64",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"UUID",
            "example":"EEFF00112233445566778899AABBCCDD"
        }
    },
    "description":"DTO specifying a data elements (form, form section, item, or repeat) to be locked or unlocked in a visit."
}

Examples

Select an example SubjectVisitsFormsItemsDTOArrayExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SubjectVisitsItemsResponseDTO

Type: object

Response DTO for bulk lock operation, includes processed and failed objects

Show Source

• exceptions: array exceptions
  Exceptions or error messages for failed objects.
• failedObjects: array failedObjects
  List of subject/visit/form/item objects which failed to process.
• processedObjects: array processedObjects
  List of successfully processed subject/visit/form/item objects.

{
    "type":"object",
    "properties":{
        "processedObjects":{
            "type":"array",
            "description":"List of successfully processed subject/visit/form/item objects.",
            "items":{
                "$ref":"#/components/schemas/SubjectVisitsFormsItemsDTO"
            }
        },
        "failedObjects":{
            "type":"array",
            "description":"List of subject/visit/form/item objects which failed to process.",
            "items":{
                "$ref":"#/components/schemas/SubjectVisitsFormsItemsDTO"
            }
        },
        "exceptions":{
            "type":"array",
            "description":"Exceptions or error messages for failed objects.",
            "example":[
                "Event not found for subject 18DFFBDF2523489AAF3DE9D6CA60B7F2"
            ],
            "items":{
                "type":"string",
                "description":"Exceptions or error messages for failed objects.",
                "example":"[\"Event not found for subject 18DFFBDF2523489AAF3DE9D6CA60B7F2\"]"
            }
        }
    },
    "description":"Response DTO for bulk lock operation, includes processed and failed objects"
}

Nested Schema : exceptions

Type: array

Exceptions or error messages for failed objects.

Show Source

• Array of: string
  Exceptions or error messages for failed objects.

  Example: ["Event not found for subject 18DFFBDF2523489AAF3DE9D6CA60B7F2"]

{
    "type":"array",
    "description":"Exceptions or error messages for failed objects.",
    "example":[
        "Event not found for subject 18DFFBDF2523489AAF3DE9D6CA60B7F2"
    ],
    "items":{
        "type":"string",
        "description":"Exceptions or error messages for failed objects.",
        "example":"[\"Event not found for subject 18DFFBDF2523489AAF3DE9D6CA60B7F2\"]"
    }
}

Example:

[
    "Event not found for subject 18DFFBDF2523489AAF3DE9D6CA60B7F2"
]

Nested Schema : failedObjects

Type: array

List of subject/visit/form/item objects which failed to process.

Show Source

• Array of: object schema
  DTO representing a subject and the list of events (visits/forms/items) to be locked.

{
    "type":"array",
    "description":"List of subject/visit/form/item objects which failed to process.",
    "items":{
        "$ref":"#/components/schemas/SubjectVisitsFormsItemsDTO"
    }
}

Nested Schema : processedObjects

Type: array

List of successfully processed subject/visit/form/item objects.

Show Source

• Array of: object schema
  DTO representing a subject and the list of events (visits/forms/items) to be locked.

{
    "type":"array",
    "description":"List of successfully processed subject/visit/form/item objects.",
    "items":{
        "$ref":"#/components/schemas/SubjectVisitsFormsItemsDTO"
    }
}

Nested Schema : schema

Type: object

DTO representing a subject and the list of events (visits/forms/items) to be locked.

Show Source

• events: array events
  List of visit/form/item objects for the subject in UUID format.
• subjectId: string (UUID)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: F5F6EA48B9D04C6F8C657CFA5A20EC53

{
    "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":"F5F6EA48B9D04C6F8C657CFA5A20EC53"
        },
        "events":{
            "type":"array",
            "description":"List of visit/form/item objects for the subject in UUID format.",
            "items":{
                "$ref":"#/components/schemas/VisitFormsItemsDTO"
            }
        }
    },
    "description":"DTO representing a subject and the list of events (visits/forms/items) to be locked."
}

Nested Schema : events

Type: array

List of visit/form/item objects for the subject in UUID format.

Show Source

• Array of: object VisitFormsItemsDTO
  DTO for event (visit) details including forms and items to be locked.

{
    "type":"array",
    "description":"List of visit/form/item objects for the subject in UUID format.",
    "items":{
        "$ref":"#/components/schemas/VisitFormsItemsDTO"
    }
}

Nested Schema : VisitFormsItemsDTO

Type: object

DTO for event (visit) details including forms and items to be locked.

Show Source

• elements: array elements
  List of data element DTOs indicating forms/items under the visit.
• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: BCAF12ED87549BA59F7A43AB6A77C1E2
• eventInstanceNum: integer (int64)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 2.0.0.38

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"BCAF12ED87549BA59F7A43AB6A77C1E2"
        },
        "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":"int64",
            "example":1
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "elements":{
            "type":"array",
            "description":"List of data element DTOs indicating forms/items under the visit.",
            "items":{
                "$ref":"#/components/schemas/DataElementRequestDTO"
            }
        }
    },
    "description":"DTO for event (visit) details including forms and items to be locked."
}

Nested Schema : elements

Type: array

List of data element DTOs indicating forms/items under the visit.

Show Source

• Array of: object DataElementRequestDTO
  DTO specifying a data elements (form, form section, item, or repeat) to be locked or unlocked in a visit.

{
    "type":"array",
    "description":"List of data element DTOs indicating forms/items under the visit.",
    "items":{
        "$ref":"#/components/schemas/DataElementRequestDTO"
    }
}

Nested Schema : DataElementRequestDTO

Type: object

DTO specifying a data elements (form, form section, item, or repeat) to be locked or unlocked in a visit.

Show Source

• formId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: AABBCCDDEEFF00112233445566778899
• formSectionId: string (UUID)
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: BB112233445566778899AABBCCDDEEFF
• innerRepeat: integer (int64)
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example: 0
• itemId: string (UUID)
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: EEFF00112233445566778899AABBCCDD
• outerRepeat: integer (int64)
  Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.

  Example: 1

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"AABBCCDDEEFF00112233445566778899"
        },
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "format":"UUID",
            "example":"BB112233445566778899AABBCCDDEEFF"
        },
        "innerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.",
            "format":"int64",
            "example":0
        },
        "outerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.",
            "format":"int64",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"UUID",
            "example":"EEFF00112233445566778899AABBCCDD"
        }
    },
    "description":"DTO specifying a data elements (form, form section, item, or repeat) to be locked or unlocked in a visit."
}

Examples

Select an example SubjectVisitsItemsResponseDTOExample

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