Jump to

• Request
• Response

v1.0

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup

Retrieves either the latest or the audit records for Source Data Verification (SDV) group.

Request

Path Parameters

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

  Example:

  active

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Query Parameters

• active: boolean
  Is Active records required: true/false.

  Example:

  true

• audit: boolean
  Is Audit Data required: true/false.

  Example:

  false

• 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
  Order in which the response records will be returned It can be : asc or desc.

  Example:

  asc

• sdvGroupId: string
  ID of the Source Data Verification (SDV) group. The format is UUID, 32-character uppercase hexadecimal string.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

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 SDVGroupInfoDTOv20
  Represents Source Data Verification (SDV) group information including audit and versioning details.

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

Nested Schema : SDVGroupInfoDTOv20

Type: object

Represents Source Data Verification (SDV) group information including audit and versioning details.

Show Source

• attributeKey: string
  Minimum Length: 0

  Maximum Length: 255

  Key for a configurable attribute associated with this SDV group. Values may be REMAINING_SUBJECTS_PERCENTAGE, REMAINING_SUBJECTS_SDV_TYPE, INITIAL_SUBJECTS_SDV_TYPE, INITIAL_SUBJECTS_COUNT.

  Example: INITIAL_SUBJECTS_COUNT
• attributeValue: string
  Minimum Length: 0

  Maximum Length: 2048

  Value for a configurable attribute associated with this SDV group. The acceptable values are - All Questions, Critical Questions Only or it can be a number like 30.

  Example: 50
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment

  Example: Configured for screening visits
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for the SDV group info record.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• 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

  Example: Initial SDV strategy creation
• sdvGroupId: string
  ID of the Source Data Verification (SDV) group. The format is UUID, 32-character uppercase hexadecimal string.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• sdvGroupName: string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the SDV group.

  Example: Screening Group
• softwareVersionNumber: number
  A number that represents an incremental increase every time a data point is modified.

  Example: 30
• 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: 9F86D081884C7D659A2FEAA0C55AD015
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2023-06-01T09:00: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 SDV group info record.",
            "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-06-01T09:00: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":"9F86D081884C7D659A2FEAA0C55AD015"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"A number that represents an incremental increase every time a data point is modified.",
            "example":30
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason",
            "example":"Initial SDV strategy creation"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment",
            "example":"Configured for screening visits"
        },
        "attributeValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Value for a configurable attribute associated with this SDV group. The acceptable values are - All Questions, Critical Questions Only or it can be a number like 30.",
            "example":"50"
        },
        "attributeKey":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Key for a configurable attribute associated with this SDV group. Values may be REMAINING_SUBJECTS_PERCENTAGE, REMAINING_SUBJECTS_SDV_TYPE, INITIAL_SUBJECTS_SDV_TYPE, INITIAL_SUBJECTS_COUNT.",
            "example":"INITIAL_SUBJECTS_COUNT"
        },
        "sdvGroupName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Human readable name of the SDV group.",
            "example":"Screening Group"
        },
        "sdvGroupId":{
            "type":"string",
            "description":"ID of the Source Data Verification (SDV) group. The format is UUID, 32-character uppercase hexadecimal string.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        }
    },
    "description":"Represents Source Data Verification (SDV) group information including audit and versioning details."
}

Examples

Select an example PaginatedSDVGroupInfoDTOv20List

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