Jump to

• Request
• Response

V5.0

get

/ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/studyversionobjects/iprDetails

Retrieves additional investigational product randomization (IPR) details for a study version.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• mode: string
  Study mode used to fetch IPR details. Optional. Allowed values: test, training, active, design.

  Default Value: test

  Example:

  test

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : DataHubIprDetailsDto

Type: object

Show Source

• forms: array forms

{
    "type":"object",
    "properties":{
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataHubIprFormDto"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object DataHubIprFormDto

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

Nested Schema : DataHubIprFormDto

Type: object

Show Source

• codeListItems: array codeListItems
• codeLists: array codeLists
• extendedProperties: array extendedProperties
• form: object DatahubDataViewsDto
• ipr: object DataHubObjectVersionsDto
• isNew: string
• items: array items
• stringResources: array stringResources
• studyEventForms: array studyEventForms
• studyVersions: array studyVersions

{
    "type":"object",
    "properties":{
        "ipr":{
            "$ref":"#/components/schemas/DataHubObjectVersionsDto"
        },
        "studyVersions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "form":{
            "$ref":"#/components/schemas/DatahubDataViewsDto"
        },
        "isNew":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubFormItemsDto"
            }
        },
        "stringResources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStringResourcesDto"
            }
        },
        "codeLists":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubCodeListsDto"
            }
        },
        "codeListItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubCodeListItemsDto"
            }
        },
        "extendedProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubExtendedPropertiesDto"
            }
        },
        "studyEventForms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatahubStudyeventFormDto"
            }
        }
    }
}

Nested Schema : codeListItems

Type: array

Show Source

• Array of: object DatahubCodeListItemsDto

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

Nested Schema : codeLists

Type: array

Show Source

• Array of: object DatahubCodeListsDto

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

Nested Schema : extendedProperties

Type: array

Show Source

• Array of: object DatahubExtendedPropertiesDto

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

Nested Schema : DatahubDataViewsDto

Type: object

Show Source

• allowMultipleInstances: integer (int64)
• comment: string
• description: string
• dynamic: integer (int32)
• formCategory: string
• formSubCategory: string
• formType: integer (int32)
• id: string (uuid)
• includeInSafetyCaseData: integer (int32)
• isNested: integer (int64)
• isRuleCopied: integer (int64)
• isShared: integer (int64)
• objectVersionNumber: number
• operationType: string
• reason: string
• refName: string
• repeating: integer (int64)
• repeatingInstanceId: string (uuid)
• shortTitleRefId: string (uuid)
• softwareVersionNumber: number
• sourceDataviewId: string (uuid)
• sourceStudyId: string (uuid)
• sourceStudyVersion: string
• sourceVersionStart: string (date-time)
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "refName":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "repeatingInstanceId":{
            "type":"string",
            "format":"uuid"
        },
        "isNested":{
            "type":"integer",
            "format":"int64"
        },
        "isShared":{
            "type":"integer",
            "format":"int64"
        },
        "shortTitleRefId":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "repeating":{
            "type":"integer",
            "format":"int64"
        },
        "dynamic":{
            "type":"integer",
            "format":"int32"
        },
        "sourceDataviewId":{
            "type":"string",
            "format":"uuid"
        },
        "sourceStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string"
        },
        "sourceVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "isRuleCopied":{
            "type":"integer",
            "format":"int64"
        },
        "formType":{
            "type":"integer",
            "format":"int32"
        },
        "includeInSafetyCaseData":{
            "type":"integer",
            "format":"int32"
        },
        "formCategory":{
            "type":"string"
        },
        "formSubCategory":{
            "type":"string"
        },
        "allowMultipleInstances":{
            "type":"integer",
            "format":"int64"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DataHubObjectVersionsDto

Type: object

Show Source

• comment: string
• id: string (uuid)
• objectId: string (uuid)
• objectType: string
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• sourceStudyVersion: string
• sourceVersionApproved: integer (int64)
• sourceVersionStart: string (date-time)
• studyId: string (uuid)
• targetStudyVersion: string
• targetVersionStart: string (date-time)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "objectId":{
            "type":"string",
            "format":"uuid"
        },
        "objectType":{
            "type":"string"
        },
        "sourceVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sourceStudyVersion":{
            "type":"string"
        },
        "targetStudyVersion":{
            "type":"string"
        },
        "targetVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sourceVersionApproved":{
            "type":"integer",
            "format":"int64"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DatahubFormItemsDto

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

Nested Schema : stringResources

Type: array

Show Source

• Array of: object DatahubStringResourcesDto

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

Nested Schema : studyEventForms

Type: array

Show Source

• Array of: object DatahubStudyeventFormDto

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

Nested Schema : studyVersions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : DatahubCodeListItemsDto

Type: object

Show Source

• clCode: string
• clValue: string
• code: string
• codeListId: string (uuid)
• codeListType: string
• comment: string
• description: string
• id: string (uuid)
• itemSeq: number
• objectVersionNumber: number
• operationType: string
• reason: string
• refName: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• valueRefId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "codeListId":{
            "type":"string",
            "format":"uuid"
        },
        "refName":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "itemSeq":{
            "type":"number"
        },
        "valueRefId":{
            "type":"string",
            "format":"uuid"
        },
        "codeListType":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "clCode":{
            "type":"string"
        },
        "clValue":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubCodeListsDto

Type: object

Show Source

• codeListType: string
• comment: string
• description: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• refName: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• title: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "refName":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "codeListType":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubExtendedPropertiesDto

Type: object

Show Source

• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• parentObjectId: string (uuid)
• parentObjectLevel: string
• propertyName: string
• propertySource: string
• propertyType: string
• propertyValue: string
• reason: string
• responseMapJson: string
• softwareVersionNumber: number
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "parentObjectId":{
            "type":"string",
            "format":"uuid"
        },
        "parentObjectLevel":{
            "type":"string"
        },
        "propertyType":{
            "type":"string"
        },
        "propertySource":{
            "type":"string"
        },
        "propertyName":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "responseMapJson":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubFormItemsDto

Type: object

Show Source

• allowAdditionalRows: integer (int64)
• allowFutureDate: integer (int32)
• applyChangeToVersion: string
• choiceType: string
• clLabNormalsTag: string
• codeListId: string (uuid)
• codelistItems: string
• columnCnt: integer (int64)
• columnLayout: string (uuid)
• comment: string
• componentSeq: integer (int32)
• dataViewId: string (uuid)
• dtFormat: string
• dtRequired: string
• dynamic: integer (int32)
• ehrMapping: array ehrMapping
• excludedLocations: string
• existingDataCodeName: string
• existingDataCodeValue: string
• formula: string
• groupId: string (uuid)
• groupItemSeq: integer (int32)
• hidden: integer (int64)
• hintId: string (uuid)
• id: string (uuid)
• ifThenFlag: integer (int64)
• instructionalText: string
• itemDescription: string
• itemRules: string
• itemTags: string
• itemTitle: string
• itemType: string
• labNormalsTag: string
• length: integer (int32)
• objectVersionNumber: number
• objectVersionsId: string (uuid)
• operationType: string
• paneSize: integer (int64)
• precision: integer (int32)
• questionId: string (uuid)
• readOnly: integer (int64)
• reason: string
• refname: string
• required: integer (int32)
• sasLabelId: string (uuid)
• sasVariable: string
• sdv: integer (int32)
• smartItemId: string (uuid)
• softwareVersionNumber: number
• source: string
• studyId: string (uuid)
• studyVersion: string
• unitOfMeasurement: string
• unitType: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "dataViewId":{
            "type":"string",
            "format":"uuid"
        },
        "itemType":{
            "type":"string"
        },
        "refname":{
            "type":"string"
        },
        "itemTitle":{
            "type":"string"
        },
        "itemDescription":{
            "type":"string"
        },
        "questionId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionsId":{
            "type":"string",
            "format":"uuid"
        },
        "sasVariable":{
            "type":"string"
        },
        "sasLabelId":{
            "type":"string",
            "format":"uuid"
        },
        "hintId":{
            "type":"string",
            "format":"uuid"
        },
        "required":{
            "type":"integer",
            "format":"int32"
        },
        "sdv":{
            "type":"integer",
            "format":"int32"
        },
        "itemRules":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "unitType":{
            "type":"string"
        },
        "unitOfMeasurement":{
            "type":"string"
        },
        "formula":{
            "type":"string"
        },
        "dtFormat":{
            "type":"string"
        },
        "dtRequired":{
            "type":"string"
        },
        "choiceType":{
            "type":"string"
        },
        "columnLayout":{
            "type":"string",
            "format":"uuid"
        },
        "codelistItems":{
            "type":"string"
        },
        "codeListId":{
            "type":"string",
            "format":"uuid"
        },
        "smartItemId":{
            "type":"string",
            "format":"uuid"
        },
        "columnCnt":{
            "type":"integer",
            "format":"int64"
        },
        "paneSize":{
            "type":"integer",
            "format":"int64"
        },
        "ifThenFlag":{
            "type":"integer",
            "format":"int64"
        },
        "excludedLocations":{
            "type":"string"
        },
        "itemTags":{
            "type":"string"
        },
        "componentSeq":{
            "type":"integer",
            "format":"int32"
        },
        "hidden":{
            "type":"integer",
            "format":"int64"
        },
        "readOnly":{
            "type":"integer",
            "format":"int64"
        },
        "groupId":{
            "type":"string",
            "format":"uuid"
        },
        "groupItemSeq":{
            "type":"integer",
            "format":"int32"
        },
        "dynamic":{
            "type":"integer",
            "format":"int32"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "allowAdditionalRows":{
            "type":"integer",
            "format":"int64"
        },
        "labNormalsTag":{
            "type":"string"
        },
        "clLabNormalsTag":{
            "type":"string"
        },
        "applyChangeToVersion":{
            "type":"string"
        },
        "instructionalText":{
            "type":"string"
        },
        "allowFutureDate":{
            "type":"integer",
            "format":"int32"
        },
        "existingDataCodeName":{
            "type":"string"
        },
        "existingDataCodeValue":{
            "type":"string"
        },
        "ehrMapping":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtoV9"
            }
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : ehrMapping

Type: array

Show Source

• Array of: object From Item Advanced Property v9.0
  Title: From Item Advanced Property v9.0

  Form Item Advanced Property

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

Nested Schema : From Item Advanced Property v9.0

Type: object

Title: From Item Advanced Property v9.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v9.0",
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtoV9"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v9.0
  Title: From Item Advanced Property Rule v9.0

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v9.0

Type: object

Title: From Item Advanced Property Rule v9.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v9.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : DatahubStringResourcesDto

Type: object

Show Source

• columnNameWU: string
• comment: string
• id: string (uuid)
• locale: string
• objectIdWU: string (uuid)
• objectTypeWU: string
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• strValue: string
• studyId: string (uuid)
• studyVersion: string
• textIX: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)

{
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "type":"string"
        },
        "strValue":{
            "type":"string"
        },
        "textIX":{
            "type":"number"
        },
        "objectTypeWU":{
            "type":"string"
        },
        "objectIdWU":{
            "type":"string",
            "format":"uuid"
        },
        "columnNameWU":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "studyVersion":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "comment":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : DatahubStudyeventFormDto

Type: object

Show Source

• comment: string
• componentSeq: integer (int32)
• componentStart: string (date-time)
• formId: string (uuid)
• formRefName: string
• formStart: string (date-time)
• formTitle: string
• id: string (uuid)
• isDynamic: integer (int32)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• studyeventEnd: string (date-time)
• studyEventRefName: string
• studyeventStart: string (date-time)
• studyId: string (uuid)
• studyVersion: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• versionStartPrecise: string (date-time)
• visitId: string (uuid)
• visitTitle: string

{
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "componentStart":{
            "type":"string",
            "format":"date-time"
        },
        "componentSeq":{
            "type":"integer",
            "format":"int32"
        },
        "visitTitle":{
            "type":"string"
        },
        "formTitle":{
            "type":"string"
        },
        "studyeventStart":{
            "type":"string",
            "format":"date-time"
        },
        "formStart":{
            "type":"string",
            "format":"date-time"
        },
        "studyeventEnd":{
            "type":"string",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "versionStartPrecise":{
            "type":"string",
            "format":"date-time"
        },
        "studyEventRefName":{
            "type":"string"
        },
        "formRefName":{
            "type":"string"
        },
        "isDynamic":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top