REST API for Clinical One Platform

Check if scope type (ITEM/VSD) item in request is eligible for clearing its data

post

/ec-dataaction-svc/rest/v2.0/studies/{studyId}/{mode}/cleardatacheck/{scope}

Checks scope type (ITEM/VSD) item is eligible for clearing its data or not, if eligible returns the item data element object data.

Request

Path Parameters

scope(required): string

scope type

Supported Media Types

Root Schema : schema

Type: object

Show Source

eventId(required): string (uuid)
eventInstanceNum: integer
formId: string (uuid)
formSectionId: string (uuid)
itemId: string (uuid)
repeatSectionFormNumber: integer
repeatSequenceNumber: integer
scope: string
studyVersion(required): string
subjectId(required): string (uuid)
value: array value

Minimum Number of Items: 0

Maximum Number of Items: 4000

{
    "required":[
        "eventId",
        "studyVersion",
        "subjectId"
    ],
    "type":"object",
    "properties":{
        "value":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "scope":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "repeatSectionFormNumber":{
            "type":"integer"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : value

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

Array of: string

{
    "maxItems":4000,
    "minItems":0,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: boolean

{
    "type":"array",
    "items":{
        "type":"boolean"
    }
}

400 Response

Bad_Request

Root Schema : RestResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.