REST API for Clinical One Platform

V1.0

delete

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/{id}

Deletes a signature configuration entry for the given ID. The specified configuration is removed completely from the study's workflow signature requirements. Returns the deleted configuration details in the response object, so clients can confirm deletion and log the previous state if needed.

Request

Path Parameters

id(required): string(uuid)
Unique identifier (UUID, uppercase HEX string) of the signature configuration to be deleted.
Example:
```
222EABDE1B9648F69D3B6250880A2B09
```
mode(required): string
Mode of the study, accepts: test, active, or training.
Example:
```
test
```
studyId(required): string
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
Example:
```
3F2504E04F8911D39A0C0305E82C3301
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successfully deleted the signature configuration. Response contains the details of the deleted configuration as a SignConfiguration object inside the RestResponse wrapper.

Root Schema : SignConfiguration

Type: object

Entity model representing persisted signature configuration in the database. Properties include forms/visits, settings, lifecycle, and audit info.

Show Source

affidavitCodeValue: string

Affidavit code value associated with the signature requirement.

Example: Electronic Signature Affidavit
comment: string

Minimum Length: 0

Maximum Length: 2048

Comment regarding the last change made to the entity.

Example: Imported via migration tool.
configName(required): string

Minimum Length: 0

Maximum Length: 4000

Name/title for the signature configuration.

Example: Archive Visit Config
emailReminder: string

Indicates if email reminders are active ('Y' or 'N').

Example: Y
id: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) for the persisted signature configuration.

Example: 11223344556677889900AABBCCDDEEFF
operationType: string

Minimum Length: 1

Maximum Length: 16

Operation type on the record, can have values CREATED, MODIFIED or REMOVED

Example: REMOVED
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for the entity creation or latest modification.

Example: Initial import.
requiredBy: string (UUID)

Delimited UUID string indicating users required to sign in (UUID, 32-character uppercase hexadecimal string).

Example: 99887766554433221100AABBCCDDEEFF
requiredOn(required): string

Minimum Length: 0

Maximum Length: 16

Allowed Values: [ "CASEBOOK", "VISIT", "FORM" ]

Level at which signature is required.

Example: FORM
requiredOnForms: string

Delimited string of form UUIDs to which config applies.

Example: AABBCCDD11223344556677889900EEFF
requiredOnVisits: string (UUID)

Delimited string of visit UUIDs (UUID, 32-character uppercase hexadecimal string) to which config applies.

Example: FFEEDDCCBBAA99887766554433221100
targetAfter: string

Event or milestone after which target is to be achieved. values can be start, completion.

Example: start
targetDate: integer (int64)

Target date for signature as integer.

Example: 3
targetSet(required): string

Minimum Length: 0

Maximum Length: 1

Indicator if a target date/condition is set (Y or N).

Example: Y
triggerAnswer: string

String or delimited string of answers that act as trigger.

Example: No
triggerQuestion: string (UUID)

UUID (UUID, 32-character uppercase hexadecimal string) of the trigger question for conditional rules.

Example: 55AA44BB33CC22DD11EEFF0011223344

{
    "required":[
        "configName",
        "requiredOn",
        "targetSet"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the persisted signature configuration.",
            "format":"UUID",
            "example":"11223344556677889900AABBCCDDEEFF"
        },
        "configName":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Name/title for the signature configuration.",
            "example":"Archive Visit Config"
        },
        "requiredOn":{
            "maxLength":16,
            "minLength":0,
            "type":"string",
            "description":"Level at which signature is required.",
            "example":"FORM",
            "enum":[
                "CASEBOOK",
                "VISIT",
                "FORM"
            ]
        },
        "affidavitCodeValue":{
            "type":"string",
            "description":"Affidavit code value associated with the signature requirement.",
            "example":"Electronic Signature Affidavit"
        },
        "requiredBy":{
            "type":"string",
            "description":"Delimited UUID string indicating users required to sign in (UUID, 32-character uppercase hexadecimal string).",
            "format":"UUID",
            "example":"99887766554433221100AABBCCDDEEFF"
        },
        "targetSet":{
            "maxLength":1,
            "minLength":0,
            "type":"string",
            "description":"Indicator if a target date/condition is set (Y or N).",
            "example":"Y"
        },
        "targetDate":{
            "type":"integer",
            "description":"Target date for signature as integer.",
            "format":"int64",
            "example":3
        },
        "targetAfter":{
            "type":"string",
            "description":"Event or milestone after which target is to be achieved. values can be start, completion.",
            "example":"start"
        },
        "emailReminder":{
            "type":"string",
            "description":"Indicates if email reminders are active ('Y' or 'N').",
            "example":"Y"
        },
        "requiredOnForms":{
            "type":"string",
            "description":"Delimited string of form UUIDs to which config applies.",
            "example":"AABBCCDD11223344556677889900EEFF"
        },
        "requiredOnVisits":{
            "type":"string",
            "description":"Delimited string of visit UUIDs (UUID, 32-character uppercase hexadecimal string) to which config applies.",
            "format":"UUID",
            "example":"FFEEDDCCBBAA99887766554433221100"
        },
        "triggerQuestion":{
            "type":"string",
            "description":"UUID (UUID, 32-character uppercase hexadecimal string) of the trigger question for conditional rules.",
            "format":"UUID",
            "example":"55AA44BB33CC22DD11EEFF0011223344"
        },
        "triggerAnswer":{
            "type":"string",
            "description":"String or delimited string of answers that act as trigger.",
            "example":"No"
        }
    },
    "description":"Entity model representing persisted signature configuration in the database. Properties include forms/visits, settings, lifecycle, and audit info."
}

Examples

400 Response

Invalid or missing ID parameter.

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: object details

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
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":"object",
            "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

Nested Schema : details

Type: object

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