Jump to

• Request
• Response

V1.0

put

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

Updates a source data verification group with unique name and values for keys (INITIAL_SUBJECTS_COUNT, REMAINING_SUBJECTS_PERCENTAGE, INITIAL_SUBJECTS_SDV_TYPE and REMAINING_SUBJECTS_SDV_TYPE).

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  active

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  7A4F9C2E18B341E3A6C42E8B9F6D3A11

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request to update SDV group attributes or rename the SDV group

Show Source

• sdvGroupKeyValPairs: array sdvGroupKeyValPairs
  List of SDV group attribute key/value pairs to update
• sdvGroupNewName: string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the SDV group.

  Example: TestSDV_GROUP1Updated
• sdvGroupOldName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the SDV group.

  Example: TestSDV_GROUP1

{
    "required":[
        "sdvGroupOldName"
    ],
    "type":"object",
    "properties":{
        "sdvGroupOldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Human readable name of the SDV group.",
            "example":"TestSDV_GROUP1"
        },
        "sdvGroupNewName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Human readable name of the SDV group.",
            "example":"TestSDV_GROUP1Updated"
        },
        "sdvGroupKeyValPairs":{
            "type":"array",
            "description":"List of SDV group attribute key/value pairs to update",
            "items":{
                "$ref":"#/components/schemas/SDVGroupKeyValDto"
            }
        }
    },
    "description":"Request to update SDV group attributes or rename the SDV group"
}

Nested Schema : sdvGroupKeyValPairs

Type: array

List of SDV group attribute key/value pairs to update

Show Source

• Array of: object SDVGroupKeyValDto
  Key-value attribute for SDV group configuration

{
    "type":"array",
    "description":"List of SDV group attribute key/value pairs to update",
    "items":{
        "$ref":"#/components/schemas/SDVGroupKeyValDto"
    }
}

Nested Schema : SDVGroupKeyValDto

Type: object

Key-value attribute for SDV group configuration

Show Source

• attributeKey(required): 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(required): string
  Minimum Length: 0

  Maximum Length: 255

  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: All Questions

{
    "required":[
        "attributeKey",
        "attributeValue"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "attributeValue":{
            "maxLength":255,
            "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":"All Questions"
        }
    },
    "description":"Key-value attribute for SDV group configuration"
}

Examples

Select an example SDVGroupRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SDVGroupInfo
  Represents Source Data Verification (SDV) group attribute entry with audit fields

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

Nested Schema : SDVGroupInfo

Type: object

Represents Source Data Verification (SDV) group attribute entry with audit fields

Show Source

• attributeKey(required): string
  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(required): string
  Minimum Length: 0

  Maximum Length: 255

  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: 20
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment regarding the last change made to the entity.

  Example: Imported via migration tool.
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 9FCBB303F8D24A3FB7DABCACF7600629
• operationType: string
  Minimum Length: 1

  Maximum Length: 16

  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: REMOVED
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the entity creation or latest modification.

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

  Example: EFC64B3862FD4C85BB8DBEAE2AE26B13
• sdvGroupName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the SDV group.

  Example: StrategyTestSite
• 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

{
    "required":[
        "attributeKey",
        "attributeValue",
        "sdvGroupName"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"9FCBB303F8D24A3FB7DABCACF7600629"
        },
        "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"
        },
        "attributeKey":{
            "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"
        },
        "attributeValue":{
            "maxLength":255,
            "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":"20"
        },
        "sdvGroupName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Human readable name of the SDV group.",
            "example":"StrategyTestSite"
        },
        "sdvGroupId":{
            "type":"string",
            "description":"ID of the Source Data Verification (SDV) group. The format is UUID, 32-character uppercase hexadecimal string.",
            "example":"EFC64B3862FD4C85BB8DBEAE2AE26B13"
        }
    },
    "description":"Represents Source Data Verification (SDV) group attribute entry with audit fields"
}

Examples

Select an example UpdateSDVGroupResponseV1

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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