REST API for Clinical One Platform

Get signature configuration of a study

get

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

Retrieves the signature configuration of a study in a particular mode.

Request

Path Parameters

mode(required): string

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

ID of the study to fetch the records for.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SignatureConfigurationDTO

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

Nested Schema : SignatureConfigurationDTO

Type: object

Show Source

affidavitCodeValue: string

Minimum Length: 0

Maximum Length: 4000
comment: string

Minimum Length: 0

Maximum Length: 2048
configName: string

Minimum Length: 0

Maximum Length: 4000
emailReminder: string

Minimum Length: 0

Maximum Length: 1
id: string (uuid)
objectVersionNumber: number
operationType: string
reason: string

Minimum Length: 0

Maximum Length: 255
requiredBy: array requiredBy

Minimum Number of Items: 0

Maximum Number of Items: 4000
requiredOn: string

Minimum Length: 0

Maximum Length: 16

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

Minimum Number of Items: 0

Maximum Number of Items: 4000
requiredOnVisits: array requiredOnVisits

Minimum Number of Items: 0

Maximum Number of Items: 4000
softwareVersionNumber: number
targetAfter: string

Minimum Length: 0

Maximum Length: 16

Allowed Values: [ "COMPLETION", "START" ]
targetDate: integer
targetSet: string

Minimum Length: 0

Maximum Length: 1
triggerAnswer: array triggerAnswer

Minimum Number of Items: 0

Maximum Number of Items: 4000
triggerQuestion: string (uuid)
userId: string (uuid)
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "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"
        },
        "configName":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "requiredOn":{
            "maxLength":16,
            "minLength":0,
            "type":"string",
            "enum":[
                "CASEBOOK",
                "VISIT",
                "FORM"
            ]
        },
        "affidavitCodeValue":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "requiredBy":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "targetSet":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "targetDate":{
            "type":"integer"
        },
        "targetAfter":{
            "maxLength":16,
            "minLength":0,
            "type":"string",
            "enum":[
                "COMPLETION",
                "START"
            ]
        },
        "emailReminder":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "requiredOnForms":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "requiredOnVisits":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "triggerQuestion":{
            "type":"string",
            "format":"uuid"
        },
        "triggerAnswer":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : requiredBy

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

Array of: string(uuid)

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

Nested Schema : requiredOnForms

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

Array of: string(uuid)

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

Nested Schema : requiredOnVisits

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 4000

Show Source

Array of: string(uuid)

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

Nested Schema : triggerAnswer

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"
    }
}

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