1. REST API for Clinical One Platform
  2. Tasks
  3. Data Actions
  4. Sign Verify Resource
  5. Get sign information

V1.0

get

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

Get paginated sign configuration eligibility records. Returns a list of eligibility information for forms and visits, filtered by study, site, subject, event, and more.

Request

Path Parameters
Query Parameters
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example:
    D27DB9E0AFE349D7980683CF55A33883
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example:
    1
  • Minimum Value: 0
    Maximum number of records to display per page.
    Example:
    10
  • 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
  • Sign eligibility status filter Values can signed, readyToSign.
    Example:
    signed
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example:
    [
    "1BC29B36F5D64B1B95F4BDBBCEA481BE"
]
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example:
    D27DB9E0AFE349D7980683CF55A33883

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : SignConfigEligibilityResponseDTO
Type: object
containing detailed sign configuration eligibility information for a subject, form, and visit.
Show Source
  • Current action status for the eligibility can view, sign.
    Example: view
  • Code value for the affidavit if applicable.
    Example: Electronic Signature Affidavit
  • Administrative comment regarding eligibility.
    Example: Included after manual review.
  • Signature configuration identifier (UUID, 32-character uppercase hexadecimal string).
    Example: 4E005942732C417D9B47C6ACBB3ACD65
  • Number of days the action is due.
    Example: 3
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: D27DB9E0AFE349D7980683CF55A33883
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 360E6122F84A43CAAF70E3BECC471A7C
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: 4FB2D38F8F9644D2B3BE08B815A8FF1A
  • Title of the associated form.
    Example: Informed Consent
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) for the sign config eligibility record
    Example: 4F3A7FD6A91E4A5FAB1EA98387E82B6B
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • Object version number
    Example: 1
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: CREATED
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 2
  • The reason for the current change.
    Example: Other.
  • Form repeat number if applicable.
    Example: 2
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 1
  • requiredBy
    List of String of UUID(UUID, 32-character uppercase hexadecimal string) of user id roles or entities that require the eligibility.
  • Indicates what element the eligibility is required on SUBJECT, FORM, CASEBOOK.
    Example: FORM
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Software version number
    Example: 3
  • Status associated with the eligibility and values can be readyToSign, signed
    Example: readyToSign
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 1.0.0.0
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: AABBCCDDEEFF00112233445566778899
  • Unique number representing subject within the study.
    Example: SUBJ1067
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user
    Example: 9AAECDD92E3F41C6AFD2B8FF1DD9CF22
  • The end date until which the data is applicable or valid.
    Example: 2023-08-10T00:00:00Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2023-08-10T00:00:00.000Z
  • Title of the associated clinical visit.
    Example: Visit 1
Nested Schema : requiredBy
Type: array
List of String of UUID(UUID, 32-character uppercase hexadecimal string) of user id roles or entities that require the eligibility.
Show Source
  • List of String of UUID(UUID, 32-character uppercase hexadecimal string) of user id roles or entities that require the eligibility.
    Example: ["A1B23C45D67E89F123456789ABCDEF12","B2C34D56E78F90A123456789ABCDEF34"]
Example:
[
    "A1B23C45D67E89F123456789ABCDEF12",
    "B2C34D56E78F90A123456789ABCDEF34"
]
Examples

400 Response

Bad_Request
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