REST API for Clinical One Platform

Add subject lock status for given subject list

post

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

API to fetch subject lock status for given subject list.

Request

Path Parameters

mode(required): string

ID of the study for which, the list of all subject data from the DAS_DATA_ACTIONS table needs to be fetched.
studyId(required): string(uuid)

ID of the study for which, the list of all subject data from the DAS_DATA_ACTIONS table needs to be fetched.

Supported Media Types

application/json

Root Schema : SubjectLockRequestDTO v1.0

Type: object

Title: SubjectLockRequestDTO v1.0

Contains a list of subjects to get lock status details

Show Source

subjects(required): array subjects

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains subjects.

{
    "title":"SubjectLockRequestDTO v1.0",
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"Contains subjects.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains a list of subjects to get lock status details"
}

Nested Schema : subjects

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains subjects.

Show Source

Array of: string(uuid)

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"Contains subjects.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataActionsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataActionsDTO"
    }
}

Nested Schema : DataActionsDTO

Type: object

Show Source

action: string
comment: string

Minimum Length: 0

Maximum Length: 2048
eventId: string (uuid)
eventInstanceNum: integer
formId: string (uuid)
formSectionId: string (uuid)
id: string (uuid)
innerRepeat: integer
itemId: string (uuid)
objectVersionNumber: number
operationType: string
outerRepeat: integer
reason: string

Minimum Length: 0

Maximum Length: 255
repeatFormNumber: integer
repeatSequenceNumber: integer
siteId: string (uuid)
softwareVersionNumber: number
studyVersion: string
subjectId: string (uuid)
userId: string (uuid)
versionEnd: string (date-time)
versionStart: string (date-time)
visitStartDateAction: string

{
    "type":"object",
    "properties":{
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "action":{
            "type":"string"
        },
        "visitStartDateAction":{
            "type":"string"
        }
    }
}

400 Response

Bad_Request

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