Jump to

• Request
• Response

V2.0

get

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

Fetches all signature configuration details. V2 includes CASEBOOK-level signatureRequired.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.
• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Array of SignatureConfigurationDTO2 objects.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SignatureConfigurationDTO2
  V2 signature configuration payload with CASEBOOK-level signatureRequired support.

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

Nested Schema : SignatureConfigurationDTO2

Type: object

V2 signature configuration payload with CASEBOOK-level signatureRequired support.

Show Source

• affidavitCodeValue: string
  Minimum Length: 0

  Maximum Length: 4000

  Affidavit code for the configuration.

  Example: Electronic Signature Affidavit
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comments about this signature configuration.

  Example: Added new signature step for visit.
• configName: string
  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
• emailReminder: string
  Minimum Length: 0

  Maximum Length: 1

  Indicator to send email reminder ('Y' or 'N').

  Example: N
• id: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) for the signature configuration in UUID format.

  Example: AABBCCDDEEFF00112233445566778899
• objectVersionNumber: number (int32)
  Audit trail field that represents the version number of the data.

  Example: 1
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: CREATED
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the configuration or operation.

  Example: Other.
• requiredBy: array requiredBy
  Minimum Number of Items: 0

  Maximum Number of Items: 4000

  List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.
• requiredOn: string
  Minimum Length: 0

  Maximum Length: 16

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

  Level at which signature is required.

  Example: FORM
• requiredOnForms: array 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: array requiredOnVisits
  Minimum Number of Items: 0

  Maximum Number of Items: 4000

  List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.
• signatureRequired: string
  Minimum Length: 0

  Maximum Length: 1

  CASEBOOK-only indicator whether signature is required for the configuration ('Y' or 'N'). Null for FORM and VISIT configurations.

  Example: Y
• softwareVersionNumber: number (int32)
  Software version number

  Example: 1
• targetAfter: string
  Minimum Length: 0

  Maximum Length: 16

  Allowed Values: [ "COMPLETION", "START" ]

  Event after which the target is considered achieved.

  Example: COMPLETION
• targetDate: integer (int64)
  Target date for signature as integer.

  Example: 2
• targetSet: string
  Minimum Length: 0

  Maximum Length: 1

  Indicator if target is set ('Y' or 'N').

  Example: Y
• triggerQuestion: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the trigger question for conditional rules.

  Example: 55AA44BB33CC22DD11EEFF0011223344
• userId: string
  User ID(UUID, 32-character uppercase hexadecimal string) that performed the operation in UUID format.

  Example: 00112233445566778899AABBCCDDEEFF
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2023-12-31T23:59:59Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2023-01-01T00:00:00Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the signature configuration in UUID format.",
            "format":"UUID",
            "example":"AABBCCDDEEFF00112233445566778899"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T00:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-12-31T23:59:59Z"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"CREATED"
        },
        "userId":{
            "type":"string",
            "description":"User ID(UUID, 32-character uppercase hexadecimal string) that performed the operation in UUID format.",
            "example":"00112233445566778899AABBCCDDEEFF"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "format":"int32",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "format":"int32",
            "example":1
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the configuration or operation.",
            "example":"Other."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comments about this signature configuration.",
            "example":"Added new signature step for visit."
        },
        "configName":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"A user-friendly name for the signature configuration, used to distinguish it from other configurations.",
            "example":"Final Visit Sign Config"
        },
        "requiredOn":{
            "maxLength":16,
            "minLength":0,
            "type":"string",
            "description":"Level at which signature is required.",
            "example":"FORM",
            "enum":[
                "CASEBOOK",
                "VISIT",
                "FORM"
            ]
        },
        "affidavitCodeValue":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Affidavit code for the configuration.",
            "example":"Electronic Signature Affidavit"
        },
        "requiredBy":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "description":"List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.",
            "example":[
                "DDEEFF00112233445566778899AABBCC"
            ],
            "items":{
                "type":"string",
                "description":"List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.",
                "format":"uuid"
            }
        },
        "targetSet":{
            "maxLength":1,
            "minLength":0,
            "type":"string",
            "description":"Indicator if target is set ('Y' or 'N').",
            "example":"Y"
        },
        "targetDate":{
            "type":"integer",
            "description":"Target date for signature as integer.",
            "format":"int64",
            "example":2
        },
        "targetAfter":{
            "maxLength":16,
            "minLength":0,
            "type":"string",
            "description":"Event after which the target is considered achieved.",
            "example":"COMPLETION",
            "enum":[
                "COMPLETION",
                "START"
            ]
        },
        "emailReminder":{
            "maxLength":1,
            "minLength":0,
            "type":"string",
            "description":"Indicator to send email reminder ('Y' or 'N').",
            "example":"N"
        },
        "requiredOnForms":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "description":"List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
            "format":"UUID",
            "example":[
                "A1B2C3D4E5F607182736454647484950"
            ],
            "items":{
                "type":"string",
                "description":"List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
                "format":"uuid"
            }
        },
        "requiredOnVisits":{
            "maxItems":4000,
            "minItems":0,
            "type":"array",
            "description":"List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
            "format":"UUID",
            "example":[
                "5A6B7C8D9E0F10293847560123456789"
            ],
            "items":{
                "type":"string",
                "description":"List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
                "format":"uuid"
            }
        },
        "triggerQuestion":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string)  of the trigger question for conditional rules.",
            "example":"55AA44BB33CC22DD11EEFF0011223344"
        },
        "signatureRequired":{
            "maxLength":1,
            "minLength":0,
            "type":"string",
            "description":"CASEBOOK-only indicator whether signature is required for the configuration ('Y' or 'N'). Null for FORM and VISIT configurations.",
            "example":"Y"
        }
    },
    "description":"V2 signature configuration payload with CASEBOOK-level signatureRequired support."
}

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

• Array of: string(uuid)
  List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.

{
    "maxItems":4000,
    "minItems":0,
    "type":"array",
    "description":"List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.",
    "example":[
        "DDEEFF00112233445566778899AABBCC"
    ],
    "items":{
        "type":"string",
        "description":"List of user IDs (UUID, 32-character uppercase hexadecimal string) required to sign.",
        "format":"uuid"
    }
}

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

• Array of: string(uuid)
  List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.

{
    "maxItems":4000,
    "minItems":0,
    "type":"array",
    "description":"List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
    "format":"UUID",
    "example":[
        "A1B2C3D4E5F607182736454647484950"
    ],
    "items":{
        "type":"string",
        "description":"List of form IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
        "format":"uuid"
    }
}

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

• Array of: string(uuid)
  List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.

{
    "maxItems":4000,
    "minItems":0,
    "type":"array",
    "description":"List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
    "format":"UUID",
    "example":[
        "5A6B7C8D9E0F10293847560123456789"
    ],
    "items":{
        "type":"string",
        "description":"List of visit IDs(UUID, 32-character uppercase hexadecimal string) required to sign.",
        "format":"uuid"
    }
}

Example:

[
    "5A6B7C8D9E0F10293847560123456789"
]

400 Response

Invalid input or request parameters.

Back to Top