Jump to

• Request
• Response

V1.0

post

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

Creates a source data verification group with unique name and values for keys (initial subjects count,remaining subject percentage, initial subjects SDF type and remaining subject SDF type).

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:

  9FCBB303F8D24A3FB7DABCACF7600629

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Source Data Verification (SDV) group configuration and its attribute key-value pairs

Show Source

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

  Example: EFC64B3862FD4C85BB8DBEAE2AE26B13
• sdvGroupKeyValPairs: array sdvGroupKeyValPairs
  Key-value attributes that define SDV strategy behavior
• sdvGroupName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the SDV group.

  Example: StrategyTestSite

{
    "required":[
        "sdvGroupName"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "sdvGroupKeyValPairs":{
            "type":"array",
            "description":"Key-value attributes that define SDV strategy behavior",
            "items":{
                "$ref":"#/components/schemas/SDVGroupKeyValDto"
            }
        }
    },
    "description":"Source Data Verification (SDV) group configuration and its attribute key-value pairs",
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : sdvGroupKeyValPairs

Type: array

Key-value attributes that define SDV strategy behavior

Show Source

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

{
    "type":"array",
    "description":"Key-value attributes that define SDV strategy behavior",
    "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 SDVGroupDto

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  Source Data Verification (SDV) group configuration and its attribute key-value pairs

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

Nested Schema : schema

Type: object

Source Data Verification (SDV) group configuration and its attribute key-value pairs

Show Source

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

  Example: EFC64B3862FD4C85BB8DBEAE2AE26B13
• sdvGroupKeyValPairs: array sdvGroupKeyValPairs
  Key-value attributes that define SDV strategy behavior
• sdvGroupName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the SDV group.

  Example: StrategyTestSite

{
    "required":[
        "sdvGroupName"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "sdvGroupKeyValPairs":{
            "type":"array",
            "description":"Key-value attributes that define SDV strategy behavior",
            "items":{
                "$ref":"#/components/schemas/SDVGroupKeyValDto"
            }
        }
    },
    "description":"Source Data Verification (SDV) group configuration and its attribute key-value pairs",
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : sdvGroupKeyValPairs

Type: array

Key-value attributes that define SDV strategy behavior

Show Source

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

{
    "type":"array",
    "description":"Key-value attributes that define SDV strategy behavior",
    "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 CreateSDVGroupResponseV1

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

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