Jump to

• Request
• Response

V1.0

get

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/configchange/studysummary

Retrieves a summary report representing the signature eligibility state for a given study. The summary includes the total due and overdue evaluations. This call is mainly used for monitoring study sign-off obligations.

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:

  E878D663A2F34F7DB33DCB0CDEE993F1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Returns the signature eligibility summary of the study.

Body ()

Root Schema : SignEligibilitySummaryResponse

Type: object

Object representing summary of signature eligibility, including number of due and overdue items.

Show Source

• due: integer (int64)
  Number of signature evaluations that are due.

  Example: 10
• overdue: integer (int64)
  Number of overdue signature evaluations.

  Example: 5

{
    "type":"object",
    "properties":{
        "due":{
            "type":"integer",
            "description":"Number of signature evaluations that are due.",
            "format":"int64",
            "example":10
        },
        "overdue":{
            "type":"integer",
            "description":"Number of overdue signature evaluations.",
            "format":"int64",
            "example":5
        }
    },
    "description":"Object representing summary of signature eligibility, including number of due and overdue items."
}

Examples

Select an example SignEligibilitySummaryResponseExample

400 Response

Bad Request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top