REST API for Clinical One Platform

V1.0

post

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

This API will return count of subjects/visits processed for lock/Unlock. For visit lock/unlock, subjectId will be added to subjectIds list and visits be to locked are added to visitIds parameter

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

Query Parameters

action(required): string
Action needs to be performed in bulk. Example: SUBJECTS_LOCK - Locks selected subjects to stop any modification, SUBJECTS_UNLOCK - Unlocks selected subjects to redo modifications, VISITS_LOCK - Locks selected visits of a subject to stop any modification, VISITS_UNLOCK - Locks selected visits of a subject to stop any modification,
Example:
```
SUBJECTS_LOCK
```

Supported Media Types

application/json

Root Schema : BulkActionDTO

Type: object

Title: BulkActionDTO

Information for bulk action

Show Source

comment: string

comment for visit/subject unlock

Example: adding lists of other visits
filters: object SubjectsVisitScheduleRequestV3

DTO for specifying filter and sorting options when scheduling visits for multiple subjects (bulk operations).
reason: string

reason for making current change

Example: other
subjectIds: array subjectIds

List of Subject Ids. For visit lock/unlock in UUID format
visitIds: array visitIds

List of visits mandatory for visit lock/unlock in UUID format

{
    "title":"BulkActionDTO",
    "type":"object",
    "properties":{
        "filters":{
            "$ref":"#/components/schemas/SubjectsVisitScheduleRequestV3"
        },
        "subjectIds":{
            "type":"array",
            "description":"List of Subject Ids. For visit lock/unlock in UUID format",
            "format":"UUID",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "type":"string",
                "description":"List of Subject Ids. For visit lock/unlock in UUID format",
                "format":"uuid"
            }
        },
        "visitIds":{
            "type":"array",
            "description":"List of visits mandatory for visit lock/unlock in UUID format",
            "items":{
                "$ref":"#/components/schemas/VisitsDTO1"
            }
        },
        "reason":{
            "type":"string",
            "description":"reason for making current change",
            "example":"other"
        },
        "comment":{
            "type":"string",
            "description":"comment for visit/subject unlock",
            "example":"adding lists of other visits"
        }
    },
    "description":"Information for bulk action"
}

Nested Schema : SubjectsVisitScheduleRequestV3

Type: object

DTO for specifying filter and sorting options when scheduling visits for multiple subjects (bulk operations).

Show Source

containsSearchKeywords: array containsSearchKeywords

Keywords for contains match in subject search which will be applied on subject number
dmViewReviewStatus: array dmViewReviewStatus

Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.
exactSearchKeywords: array exactSearchKeywords

Keywords for exact match in subject search which will be applied on subject number
limit: integer (int32)

Maximum number of results to return

Example: 25
nextVisitOnly: boolean

When true, only the next scheduled visit is returned per subject

Example: false
notStarted: boolean

When true, include only subjects that have not started

Example: false
offset: integer (int32)

Offset for pagination

Example: 0
order: string

Sort order for results

Example: asc
reviewStatus: string

Review status filter applied to subjects. Values can be noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify, all, signedandverified, frozen

Example: all
safetyCaseStatus: string

Indicates the safety case status filter. values can be SUBMITTED, CREATED, MODIFIED, SUBMIT_FAILED, CANCEL_FAILED, CANCELLED, DISMISSED, ACCEPTED, REJECTED, TRANSFER_FAILED, ALL.

Example: ALL
sites: array sites

List of site identifiers to scope the search
subjectStates: array subjectStates

States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed

{
    "type":"object",
    "properties":{
        "sites":{
            "type":"array",
            "description":"List of site identifiers to scope the search",
            "example":[
                "D3C9A4B5E6F78123456789ABCDEF1234",
                "E1F2A3B4C5D6E7F89012ABCDEF345678"
            ],
            "items":{
                "type":"string",
                "description":"List of site identifiers to scope the search",
                "format":"uuid"
            }
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of results to return",
            "format":"int32",
            "example":25
        },
        "offset":{
            "type":"integer",
            "description":"Offset for pagination",
            "format":"int32",
            "example":0
        },
        "order":{
            "type":"string",
            "description":"Sort order for results",
            "example":"asc"
        },
        "reviewStatus":{
            "type":"string",
            "description":"Review status filter applied to subjects. Values can be noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify, all, signedandverified, frozen ",
            "example":"all"
        },
        "subjectStates":{
            "type":"array",
            "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
            "example":[
                "Auto_Screen_Failed"
            ],
            "items":{
                "type":"string",
                "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
                "example":"[\"Auto_Screen_Failed\"]"
            }
        },
        "exactSearchKeywords":{
            "type":"array",
            "description":"Keywords for exact match in subject search which will be applied on subject number",
            "example":[
                "1001",
                "SMITH"
            ],
            "items":{
                "type":"string",
                "description":"Keywords for exact match in subject search which will be applied on subject number",
                "example":"[\"1001\",\"SMITH\"]"
            }
        },
        "containsSearchKeywords":{
            "type":"array",
            "description":"Keywords for contains match in subject search which will be applied on subject number",
            "example":[
                "100",
                "SMI"
            ],
            "items":{
                "type":"string",
                "description":"Keywords for contains match in subject search which will be applied on subject number",
                "example":"[\"100\",\"SMI\"]"
            }
        },
        "nextVisitOnly":{
            "type":"boolean",
            "description":"When true, only the next scheduled visit is returned per subject",
            "example":false
        },
        "notStarted":{
            "type":"boolean",
            "description":"When true, include only subjects that have not started",
            "example":false
        },
        "safetyCaseStatus":{
            "type":"string",
            "description":"Indicates the safety case status filter. values can be SUBMITTED, CREATED, MODIFIED, SUBMIT_FAILED, CANCEL_FAILED, CANCELLED, DISMISSED, ACCEPTED, REJECTED, TRANSFER_FAILED, ALL.",
            "example":"ALL"
        },
        "dmViewReviewStatus":{
            "type":"array",
            "description":"Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.",
            "example":[
                "readytoverify"
            ],
            "items":{
                "type":"string",
                "description":"Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.",
                "example":"[\"readytoverify\"]"
            }
        }
    },
    "description":"DTO for specifying filter and sorting options when scheduling visits for multiple subjects (bulk operations)."
}

Nested Schema : subjectIds

Type: array

List of Subject Ids. For visit lock/unlock in UUID format

Show Source

Array of: string(uuid)

List of Subject Ids. For visit lock/unlock in UUID format

{
    "type":"array",
    "description":"List of Subject Ids. For visit lock/unlock in UUID format",
    "format":"UUID",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "type":"string",
        "description":"List of Subject Ids. For visit lock/unlock in UUID format",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "6AF54DB79B764662B685D68C52AB0B84"
]

Nested Schema : visitIds

Type: array

List of visits mandatory for visit lock/unlock in UUID format

Show Source

Array of: object VisitsDTO1

Takes eventId and eventInstanceNum to uniquely reference a visit instance

{
    "type":"array",
    "description":"List of visits mandatory for visit lock/unlock in UUID format",
    "items":{
        "$ref":"#/components/schemas/VisitsDTO1"
    }
}

Nested Schema : containsSearchKeywords

Type: array

Keywords for contains match in subject search which will be applied on subject number

Show Source

Array of: string

Keywords for contains match in subject search which will be applied on subject number

Example: ["100","SMI"]

{
    "type":"array",
    "description":"Keywords for contains match in subject search which will be applied on subject number",
    "example":[
        "100",
        "SMI"
    ],
    "items":{
        "type":"string",
        "description":"Keywords for contains match in subject search which will be applied on subject number",
        "example":"[\"100\",\"SMI\"]"
    }
}

Example:

[
    "100",
    "SMI"
]

Nested Schema : dmViewReviewStatus

Type: array

Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.

Show Source

Array of: string

Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.

Example: ["readytoverify"]

{
    "type":"array",
    "description":"Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.",
    "example":[
        "readytoverify"
    ],
    "items":{
        "type":"string",
        "description":"Review status for data management view.The acceptable values are: noopenqueries, openqueries, verified, signed, locked, allvisitscomplete, readytosign, allvisitscomplete, readytoverify.",
        "example":"[\"readytoverify\"]"
    }
}

Example:

[
    "readytoverify"
]

Nested Schema : exactSearchKeywords

Type: array

Keywords for exact match in subject search which will be applied on subject number

Show Source

Array of: string

Keywords for exact match in subject search which will be applied on subject number

Example: ["1001","SMITH"]

{
    "type":"array",
    "description":"Keywords for exact match in subject search which will be applied on subject number",
    "example":[
        "1001",
        "SMITH"
    ],
    "items":{
        "type":"string",
        "description":"Keywords for exact match in subject search which will be applied on subject number",
        "example":"[\"1001\",\"SMITH\"]"
    }
}

Example:

[
    "1001",
    "SMITH"
]

Nested Schema : sites

Type: array

List of site identifiers to scope the search

Show Source

Array of: string(uuid)

List of site identifiers to scope the search

{
    "type":"array",
    "description":"List of site identifiers to scope the search",
    "example":[
        "D3C9A4B5E6F78123456789ABCDEF1234",
        "E1F2A3B4C5D6E7F89012ABCDEF345678"
    ],
    "items":{
        "type":"string",
        "description":"List of site identifiers to scope the search",
        "format":"uuid"
    }
}

Example:

[
    "D3C9A4B5E6F78123456789ABCDEF1234",
    "E1F2A3B4C5D6E7F89012ABCDEF345678"
]

Nested Schema : subjectStates

Type: array

States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed

Show Source

Array of: string

States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed

Example: ["Auto_Screen_Failed"]

{
    "type":"array",
    "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
    "example":[
        "Auto_Screen_Failed"
    ],
    "items":{
        "type":"string",
        "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed",
        "example":"[\"Auto_Screen_Failed\"]"
    }
}

Example:

[
    "Auto_Screen_Failed"
]

Nested Schema : VisitsDTO1

Type: object

Takes eventId and eventInstanceNum to uniquely reference a visit instance

Show Source

eventId: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

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

{
    "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":"D27DB9E0AFE349D7980683CF55A33883"
        },
        "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
        }
    },
    "description":"Takes eventId and eventInstanceNum to uniquely reference a visit instance"
}

Examples

Response

Supported Media Types

application/json

200 Response

Success - integer body lists number of subjects/visits affected by bulk action.

Examples

400 Response

Bad_Request

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