REST API for Clinical One Platform

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

post

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

Checks if the 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

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: string

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
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":"string",
            "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