Jump to

• Request
• Response

Perform given action in bulk for given subject or visit IDs

post

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

Performs an action in bulk for specified subjects or visits based on query parameters.

Request

Path Parameters

• mode(required): string
  Mode to fetch the records for.
• studyId(required): string(uuid)
  ID of the study to fetch the records for.

Query Parameters

• action(required): string
  Performs an action (lock or unlock) on the specified Subject or one of its Visits based on the provided input record.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : BulkActionDTO

Type: object

Title: BulkActionDTO

Information for bulk action

Show Source

• comment: string
  comment for visit/subject unlock

  Example: comment
• filters: object filters
  filters for fetching subjectIds. For subject lock either filters or subjectIds should be there
• reason: string
  reason for visit/subject unlock. Mandatory for unlock events

  Example: reason
• subjectIds: array subjectIds
  List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed
• visitIds: array visitIds
  List of visits mandatory for visit lock/unlock

{
    "title":"BulkActionDTO",
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "description":"filters for fetching subjectIds. For subject lock either filters or subjectIds should be there",
            "format":"SubjectsVisitScheduleRequestV2",
            "example":{
                "sites":[
                    "11111111-1111-1111-1111-111111111111",
                    "22222222-2222-2222-2222-222222222222"
                ],
                "limit":10,
                "offset":0,
                "order":"ASC",
                "reviewStatus":"PENDING",
                "subjectStates":[
                    "SCREENING_INITIATED",
                    "RANDOMIZED"
                ],
                "exactSearchKeywords":[
                    "keyword1",
                    "keyword2"
                ],
                "containsSearchKeywords":[
                    "searchKeyword1",
                    "searchKeyword2"
                ],
                "nextVisitOnly":true,
                "notStarted":false,
                "projectionTillDate":"01-Jan-2024"
            }
        },
        "subjectIds":{
            "type":"array",
            "description":"List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "type":"string",
                "description":"List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed",
                "format":"uuid"
            }
        },
        "visitIds":{
            "type":"array",
            "description":"List of visits mandatory for visit lock/unlock",
            "example":[
                {
                    "eventId":"D27DB9E0AFE349D7980683CF55A33883",
                    "eventInstanceNum":null
                },
                {
                    "eventId":"AE8DC4C6B0EA491D951F67CBA6C7A0FA",
                    "eventInstanceNum":null
                }
            ],
            "items":{
                "$ref":"#/components/schemas/VisitsDTO"
            }
        },
        "reason":{
            "type":"string",
            "description":"reason for visit/subject unlock. Mandatory for unlock events",
            "example":"reason"
        },
        "comment":{
            "type":"string",
            "description":"comment for visit/subject unlock",
            "example":"comment"
        }
    },
    "description":"Information for bulk action"
}

Nested Schema : filters

Type: object

filters for fetching subjectIds. For subject lock either filters or subjectIds should be there

Example:

{
    "sites":[
        "11111111-1111-1111-1111-111111111111",
        "22222222-2222-2222-2222-222222222222"
    ],
    "limit":10,
    "offset":0,
    "order":"ASC",
    "reviewStatus":"PENDING",
    "subjectStates":[
        "SCREENING_INITIATED",
        "RANDOMIZED"
    ],
    "exactSearchKeywords":[
        "keyword1",
        "keyword2"
    ],
    "containsSearchKeywords":[
        "searchKeyword1",
        "searchKeyword2"
    ],
    "nextVisitOnly":true,
    "notStarted":false,
    "projectionTillDate":"01-Jan-2024"
}

Nested Schema : subjectIds

Type: array

List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed

Show Source

• Array of: string(uuid)
  List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed

{
    "type":"array",
    "description":"List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "type":"string",
        "description":"List of Subject Ids. For visit lock/unlock only 1 subjectId is allowed",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "6AF54DB79B764662B685D68C52AB0B84"
]

Nested Schema : visitIds

Type: array

List of visits mandatory for visit lock/unlock

Show Source

• Array of: object VisitsDTO

{
    "type":"array",
    "description":"List of visits mandatory for visit lock/unlock",
    "example":[
        {
            "eventId":"D27DB9E0AFE349D7980683CF55A33883",
            "eventInstanceNum":null
        },
        {
            "eventId":"AE8DC4C6B0EA491D951F67CBA6C7A0FA",
            "eventInstanceNum":null
        }
    ],
    "items":{
        "$ref":"#/components/schemas/VisitsDTO"
    }
}

Example:

[
    {
        "eventId":"D27DB9E0AFE349D7980683CF55A33883",
        "eventInstanceNum":null
    },
    {
        "eventId":"AE8DC4C6B0EA491D951F67CBA6C7A0FA",
        "eventInstanceNum":null
    }
]

Nested Schema : VisitsDTO

Type: object

Show Source

• eventId: string (uuid)
• eventInstanceNum: integer

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top