Jump to

• Request
• Response

V1.0

get

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

Retrieves a paginated list of signature and freeze information for the data elements of the given subject (or all subjects) and study/mode. Allows filtering by subject. Results are paginated.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  A7D1B827194D4E49B8B67FDEEF6F36C1

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Maximum number of records to display per page.

  Example:

  25

• offset: integer(int32)
  Minimum Value: 0

  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Example:

  0

• order: string
  asc or desc

  Example:

  asc

• subjectId: string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C39E34A9152148E0BB831239BAA3E502

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SignVerifyFreezeDTOv20
  DTO representing signature and freeze information for a data element in a study.

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

Nested Schema : SignVerifyFreezeDTOv20

Type: object

DTO representing signature and freeze information for a data element in a study.

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comments if provided

  Example: Data discrepancy observed and clarified
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: AF77C6450BE94DE293C9630142E0AFAD
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example: 3
• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 7978B7DD0A0A4CA899C485990994300C
• freeze: string
  Freeze status can be of FROZEN, UNFROZEN, NEVER_FROZEN

  Example: FROZEN
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for the Sign/Verify/Freeze record in UUID format

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• itemId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.

  Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
• objectVersionNumber: number
  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 to make this change

  Example: Other
• repeatSequenceNumber: integer (int64)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1
• signed: string
  Signed status can be of SIGNED, UNSIGNED, NEVER_SIGNED, PARTIAL_SIGNED

  Example: 2C3F40649C654D0F995A7FDBBCEA4FAB
• softwareVersionNumber: number
  Software version number

  Example: 100
• studyVersion: string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 2.0.0.38
• subjectId: string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: C39E34A9152148E0BB831239BAA3E502
• userId: string
  Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 2C3F40649C654D0F995A7FDBBCEA4FAB
• verify: string
  Verify status can be UNVERIFIED, VERIFIED, NEVER_VERIFIED, VERIFY_REQUIRED

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

  Example: 2023-01-02T17:30:00Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the Sign/Verify/Freeze record in UUID format",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "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-01T09:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-01-02T17:30:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"CREATED"
        },
        "userId":{
            "type":"string",
            "description":"Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"2C3F40649C654D0F995A7FDBBCEA4FAB"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "example":100
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"reason to make this change",
            "example":"Other"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comments if provided",
            "example":"Data discrepancy observed and clarified"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"C39E34A9152148E0BB831239BAA3E502"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"AF77C6450BE94DE293C9630142E0AFAD"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int64",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "example":"33CAF3CB1DF64DF5A353A337CBE6B50A"
        },
        "signed":{
            "type":"string",
            "description":"Signed status can be of SIGNED, UNSIGNED, NEVER_SIGNED, PARTIAL_SIGNED ",
            "example":"2C3F40649C654D0F995A7FDBBCEA4FAB"
        },
        "verify":{
            "type":"string",
            "description":"Verify status can be UNVERIFIED, VERIFIED, NEVER_VERIFIED, VERIFY_REQUIRED",
            "example":"VERIFIED"
        },
        "freeze":{
            "type":"string",
            "description":"Freeze status can be of FROZEN, UNFROZEN, NEVER_FROZEN",
            "example":"FROZEN"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":3
        }
    },
    "description":"DTO representing signature and freeze information for a data element in a study."
}

Examples

Select an example Get Sign Verify and freeze Response Example

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top