1. REST API for Clinical One Platform
  2. Tasks
  3. Data Actions
  4. Signature Configuration
  5. Save signature configuration of a study

V1.0

post

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

Creates a new signature configuration for the given study and mode. Use this endpoint to define new signature rules and requirements for a study workflow.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request payload for saving a new signature configuration. Specifies forms, visits, users, triggers, and other settings for electronic signatures.
Show Source
  • Minimum Length: 0
    Maximum Length: 4000
    Affidavit code associated with this configuration.
    Example: Electronic Signature Affidavit
  • Minimum Length: 0
    Maximum Length: 4000
    Name of the signature configuration.
    Example: Final Visit Sign Config
  • Minimum Length: 0
    Maximum Length: 1
    Indicator for sending email reminders ('Y' or 'N').
    Example: N
  • requiredBy
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of user IDs(UUID, 32-character uppercase hexadecimal string) who are required to sign.
  • Minimum Length: 0
    Maximum Length: 16
    Allowed Values: [ "CASEBOOK", "VISIT", "FORM" ]
    Level at which signature is required.
    Example: FORM
  • requiredOnForms
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of form UUIDs(UUID, 32-character uppercase hexadecimal string) required to sign.
  • requiredOnVisits
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of visit UUIDs(UUID, 32-character uppercase hexadecimal string) required to sign.
  • Minimum Length: 0
    Maximum Length: 16
    Allowed Values: [ "COMPLETION", "START" ]
    Event after which the target is achieved.
    Example: COMPLETION
  • Target date for signature as integer.
    Example: 3
  • Minimum Length: 0
    Maximum Length: 1
    Indicator if a target is set ('Y' or 'N').
    Example: Y
  • triggerAnswer
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of trigger answers used for conditional signatures.
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the trigger question for conditional signatures.
    Example: 66778899AABBCCDDEEFF001122334455
Nested Schema : requiredBy
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of user IDs(UUID, 32-character uppercase hexadecimal string) who are required to sign.
Show Source
  • List of user IDs(UUID, 32-character uppercase hexadecimal string) who are required to sign.
Example:
[
    "DDEEFF00112233445566778899AABBCC"
]
Nested Schema : requiredOnForms
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of form UUIDs(UUID, 32-character uppercase hexadecimal string) required to sign.
Show Source
Example:
[
    "A1B2C3D4E5F607182736454647484950"
]
Nested Schema : requiredOnVisits
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of visit UUIDs(UUID, 32-character uppercase hexadecimal string) required to sign.
Show Source
Example:
[
    "5A6B7C8D9E0F10293847560123456789"
]
Nested Schema : triggerAnswer
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of trigger answers used for conditional signatures.
Show Source
  • List of trigger answers used for conditional signatures.
    Example: ["Yes"]
Example:
[
    "Yes"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Successfully created the signature configuration. Returns the created SignatureConfigurationDTO object.
Body ()
Root Schema : SignatureConfigurationDTO
Type: object
Represents the configuration for electronic signatures for a study, including the required forms, visits, users, and rules.
Show Source
  • Minimum Length: 0
    Maximum Length: 4000
    Affidavit code for the configuration.
    Example: Electronic Signature Affidavit
  • Minimum Length: 0
    Maximum Length: 2048
    Additional comments about this signature configuration.
    Example: Added new signature step for visit.
  • Minimum Length: 0
    Maximum Length: 4000
    A user-friendly name for the signature configuration, used to distinguish it from other configurations.
    Example: Final Visit Sign Config
  • Minimum Length: 0
    Maximum Length: 1
    Indicator to send email reminder ('Y' or 'N').
    Example: N
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) for the signature configuration in UUID format.
    Example: AABBCCDDEEFF00112233445566778899
  • Object version number
    Example: 1
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: CREATED
  • Minimum Length: 0
    Maximum Length: 255
    Reason for the configuration or operation.
    Example: Other.
  • requiredBy
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.
  • Minimum Length: 0
    Maximum Length: 16
    Allowed Values: [ "CASEBOOK", "VISIT", "FORM" ]
    Level at which signature is required.
    Example: FORM
  • requiredOnForms
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.
  • requiredOnVisits
    Minimum Number of Items: 0
    Maximum Number of Items: 4000
    List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.
  • Software version number
    Example: 1
  • Minimum Length: 0
    Maximum Length: 16
    Allowed Values: [ "COMPLETION", "START" ]
    Event after which the target is considered achieved.
    Example: COMPLETION
  • Target date for signature as integer.
    Example: 2
  • Minimum Length: 0
    Maximum Length: 1
    Indicator if target is set ('Y' or 'N').
    Example: Y
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the trigger question for conditional rules.
    Example: 55AA44BB33CC22DD11EEFF0011223344
  • User ID(UUID, 32-character uppercase hexadecimal string) that performed the operation in UUID format.
    Example: 00112233445566778899AABBCCDDEEFF
  • The end date until which the data is applicable or valid.
    Example: 2023-12-31T23:59:59Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2023-01-01T00:00:00Z
Nested Schema : requiredBy
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.
Show Source
Example:
[
    "DDEEFF00112233445566778899AABBCC"
]
Nested Schema : requiredOnForms
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.
Show Source
Example:
[
    "A1B2C3D4E5F607182736454647484950"
]
Nested Schema : requiredOnVisits
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 4000
List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.
Show Source
Example:
[
    "5A6B7C8D9E0F10293847560123456789"
]
Examples

400 Response

Invalid input, missing required fields, or validation error.
Body ()
Root Schema : RestResponse
Type: object
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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
Back to Top