REST API for Clinical One Platform

Unsign and unverify item

put

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unsign-unverifyforitem

Updates item to unsigned and unverified status.

Request

Path Parameters

mode(required): string

Mode to fetch the record for.
studyId(required): string

ID of the study for which you want to get the list of subjects.

Query Parameters

action: string
clearitem: boolean

Supported Media Types

Root Schema : schema

Type: object

Show Source

comment: string
elements: array elements
eventId: string
eventInstanceNum: integer
reason: string
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "elements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreSignVerifyRequestDto"
            }
        }
    },
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : elements

Type: array

Show Source

Array of: object CoreSignVerifyRequestDto

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

Nested Schema : CoreSignVerifyRequestDto

Type: object

Show Source

eventInstanceNumber: integer
formId: string
formSectionId: string
innerRepeat: integer
itemId: string
outerRepeat: integer
repeatFormNumber: integer
repeatSequenceNumber: integer

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "eventInstanceNumber":{
            "type":"integer"
        },
        "itemId":{
            "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