Jump to

• Request
• Response

V1.0

put

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}

Updates a specified study's version.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  The Version id

  Example:

  1.0.0.1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match One Schema

Show Source

• object StudyVersionDto v1.0
  Title: StudyVersionDto v1.0

  Information about a study version.
• object StudyDto v1.0
  Title: StudyDto v1.0

  Information about a study for UI consumption.

{
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/StudyVersionDtoV1"
        },
        {
            "$ref":"#/components/schemas/StudyDtoV1"
        }
    ]
}

Nested Schema : StudyVersionDto v1.0

Type: object

Title: StudyVersionDto v1.0

Information about a study version.

Show Source

• previousVersion: string
  Previous version

  Example: 1.3.0.6
• versionTitle(required): string
  Name of the latest study version

  Example: Study03:2.0.0.7
• versionType: string
  Type of study version

  Example: PROTOCOL_AMENDMENT

{
    "title":"StudyVersionDto v1.0",
    "required":[
        "versionTitle"
    ],
    "type":"object",
    "properties":{
        "versionType":{
            "type":"string",
            "description":"Type of study version",
            "example":"PROTOCOL_AMENDMENT"
        },
        "versionTitle":{
            "type":"string",
            "description":"Name of the latest study version",
            "example":"Study03:2.0.0.7"
        },
        "previousVersion":{
            "type":"string",
            "description":"Previous version",
            "example":"1.3.0.6"
        }
    },
    "description":"Information about a study version."
}

Nested Schema : StudyDto v1.0

Type: object

Title: StudyDto v1.0

Information about a study for UI consumption.

Show Source

• approvedVersionsCount: integer (int32)
  Count of study in approved mode

  Example: 1
• archivedVersionsCount: integer (int32)
  Count of study in archived mode

  Example: 1
• contractCode: string
  Study contract code or identifier

  Example: NCT00000419
• customerRefNo: string
  Customer reference number
• description: string
  Study description
• draftVersionsCount: integer (int32)
  Count of study in draft mode

  Example: 1
• everApprovedCount: integer (int32)
  If study was ever approved

  Example: 1
• hasObjects: integer (int32)
  If study contains any artifacts

  Example: 1
• id: string (uuid)
  Study Unique GUID
• identity: string
  Study identity - concatenation of study id and version

  Example: 8C4ECDFD9C214D38B4E68D3107BA0AF9:1.0.0.3
• modes: array modes
• openLabelBlinded: string
  Study type for open label and blinded

  Example: DoubleBlinded
• singleKitSettingId: string
  Single kit id
• sowNo: string
  SOW number
• sponsorId: string
  Sponsor Id
• studyDescription: string
  Study description or protocol title

  Example: A randomized double blind placebo controlled study to investigate the safety of microphylla in healthy adult volunteers.
• studyPhase: string
  Study phase

  Example: II
• studyStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Current study status

  Example: APPROVED
• studyStatusId: integer (int32)
  Study status Id
• studyTitle: string
  Study Title or protocol number

  Example: TICIPS001
• testingVersionsCount: integer (int32)
  Count of study in testing mode

  Example: 1
• therapeuticArea: string
  Study therapeutic area

  Example: Infectious Diseases
• useBlindingGroups: boolean
  Whether study uses blinding groups
• useLabelGroups: boolean
  Whether study uses label groups
• useShippinggroups: boolean
  Whether study uses shipping groups
• version: string
  Study version

  Example: 1.0.0.3
• versionEnd: string (date-time)
  Version End

  Example: 3099-12-31T05:00:00Z
• versionPreviousStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Previous study status

  Example: TESTING
• versionStart: string (date-time)
  Version Start date
• versionStatus: string
  Study version status

  Example: Active, not recruiting
• versionTitle: string
  Study Title or protocol number

  Example: TICIPS001:1.0.0.3
• versionType: string
  Study version type

  Example: Active, not recruiting

{
    "title":"StudyDto v1.0",
    "type":"object",
    "properties":{
        "identity":{
            "type":"string",
            "description":"Study identity - concatenation of study id and version",
            "example":"8C4ECDFD9C214D38B4E68D3107BA0AF9:1.0.0.3"
        },
        "id":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.3"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001"
        },
        "studyDescription":{
            "type":"string",
            "description":"Study description or protocol title",
            "example":"A randomized double blind placebo controlled study to investigate the safety of microphylla in healthy adult volunteers."
        },
        "contractCode":{
            "type":"string",
            "description":"Study contract code or identifier",
            "example":"NCT00000419"
        },
        "versionTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001:1.0.0.3"
        },
        "studyPhase":{
            "type":"string",
            "description":"Study phase",
            "example":"II"
        },
        "therapeuticArea":{
            "type":"string",
            "description":"Study therapeutic area",
            "example":"Infectious Diseases"
        },
        "openLabelBlinded":{
            "type":"string",
            "description":"Study type for open label and blinded",
            "example":"DoubleBlinded"
        },
        "studyStatus":{
            "type":"string",
            "description":"Current study status",
            "example":"APPROVED",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionType":{
            "type":"string",
            "description":"Study version type",
            "example":"Active, not recruiting"
        },
        "hasObjects":{
            "type":"integer",
            "description":"If study contains any artifacts",
            "format":"int32",
            "example":1
        },
        "draftVersionsCount":{
            "type":"integer",
            "description":"Count of study in draft mode",
            "format":"int32",
            "example":1
        },
        "testingVersionsCount":{
            "type":"integer",
            "description":"Count of study in testing mode",
            "format":"int32",
            "example":1
        },
        "approvedVersionsCount":{
            "type":"integer",
            "description":"Count of study in approved mode",
            "format":"int32",
            "example":1
        },
        "archivedVersionsCount":{
            "type":"integer",
            "description":"Count of study in archived mode",
            "format":"int32",
            "example":1
        },
        "everApprovedCount":{
            "type":"integer",
            "description":"If study was ever approved",
            "format":"int32",
            "example":1
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Study modes",
                "example":"active",
                "enum":[
                    "test",
                    "training",
                    "active"
                ]
            }
        },
        "customerRefNo":{
            "type":"string",
            "description":"Customer reference number"
        },
        "description":{
            "type":"string",
            "description":"Study description"
        },
        "singleKitSettingId":{
            "type":"string",
            "description":"Single kit id"
        },
        "sowNo":{
            "type":"string",
            "description":"SOW number"
        },
        "sponsorId":{
            "type":"string",
            "description":"Sponsor Id"
        },
        "studyStatusId":{
            "type":"integer",
            "description":"Study status Id",
            "format":"int32"
        },
        "useBlindingGroups":{
            "type":"boolean",
            "description":"Whether study uses blinding groups"
        },
        "useLabelGroups":{
            "type":"boolean",
            "description":"Whether study uses label groups"
        },
        "useShippinggroups":{
            "type":"boolean",
            "description":"Whether study uses shipping groups"
        }
    },
    "description":"Information about a study for UI consumption."
}

Nested Schema : modes

Type: array

Show Source

• Array of: string
  Allowed Values: [ "test", "training", "active" ]

  Study modes

  Example: active

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Study modes",
        "example":"active",
        "enum":[
            "test",
            "training",
            "active"
        ]
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : StudyDto v3.0

Type: object

Title: StudyDto v3.0

Information about a study for UI consumption.

Show Source

• approvedVersionsCount: integer (int32)
  Count of study in approved mode

  Example: 1
• archivedVersionsCount: integer (int32)
  Count of study in archived mode

  Example: 1
• contractCode: string
  Study contract code or identifier

  Example: NCT00000419
• customerRefNo: string
  Customer reference number
• description: string
  Study description
• draftVersionsCount: integer (int32)
  Count of study in draft mode

  Example: 1
• everApprovedCount: integer (int32)
  If study was ever approved

  Example: 1
• hasObjects: integer (int32)
  If study contains any artifacts

  Example: 1
• id: string (uuid)
  Study Unique GUID
• identity: string
  Study identity - concatenation of study id and version

  Example: 8C4ECDFD9C214D38B4E68D3107BA0AF9:1.0.0.3
• lastModified: string (date-time)
• modes: array modes
• name: string
  Study name

  Example: Study 03
• openLabelBlinded: string
  Study type for open label and blinded

  Example: DoubleBlinded
• previousState: string
  Allowed Values: [ "settings, active, design, test, training" ]

  Previous study state
• singleKitSettingId: string
  Single kit id
• sowNo: string
  SOW number
• sponsorId: string
  Sponsor Id
• studyDescription: string
  Study description or protocol title

  Example: A randomized double blind placebo controlled study to investigate the safety of microphylla in healthy adult volunteers.
• studyPhase: string
  Study phase

  Example: II
• studyState: string
  Allowed Values: [ "settings, active, design, test, training" ]

  Current study state
• studyStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Current study status

  Example: APPROVED
• studyStatusId: integer (int32)
  Study status Id
• studyTitle: string
  Study Title or protocol number

  Example: TICIPS001
• testingVersionsCount: integer (int32)
  Count of study in testing mode

  Example: 1
• therapeuticArea: string
  Study therapeutic area

  Example: Infectious Diseases
• useBlindingGroups: boolean
  Whether study uses blinding groups
• useLabelGroups: boolean
  Whether study uses label groups
• useShippinggroups: boolean
  Whether study uses shipping groups
• version: string
  Study version

  Example: 1.0.0.3
• versionEnd: string (date-time)
  Version End

  Example: 3099-12-31T05:00:00Z
• versionPreviousStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Previous study status

  Example: TESTING
• versionStart: string (date-time)
  Version Start date
• versionStatus: string
  Study version status

  Example: Active, not recruiting
• versionTitle: string
  Study Title or protocol number

  Example: TICIPS001:1.0.0.3
• versionType: string
  Study version type

  Example: Active, not recruiting

{
    "title":"StudyDto v3.0",
    "type":"object",
    "properties":{
        "identity":{
            "type":"string",
            "description":"Study identity - concatenation of study id and version",
            "example":"8C4ECDFD9C214D38B4E68D3107BA0AF9:1.0.0.3"
        },
        "id":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.3"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        },
        "name":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001"
        },
        "studyDescription":{
            "type":"string",
            "description":"Study description or protocol title",
            "example":"A randomized double blind placebo controlled study to investigate the safety of microphylla in healthy adult volunteers."
        },
        "contractCode":{
            "type":"string",
            "description":"Study contract code or identifier",
            "example":"NCT00000419"
        },
        "versionTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001:1.0.0.3"
        },
        "studyPhase":{
            "type":"string",
            "description":"Study phase",
            "example":"II"
        },
        "therapeuticArea":{
            "type":"string",
            "description":"Study therapeutic area",
            "example":"Infectious Diseases"
        },
        "openLabelBlinded":{
            "type":"string",
            "description":"Study type for open label and blinded",
            "example":"DoubleBlinded"
        },
        "studyStatus":{
            "type":"string",
            "description":"Current study status",
            "example":"APPROVED",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionType":{
            "type":"string",
            "description":"Study version type",
            "example":"Active, not recruiting"
        },
        "hasObjects":{
            "type":"integer",
            "description":"If study contains any artifacts",
            "format":"int32",
            "example":1
        },
        "draftVersionsCount":{
            "type":"integer",
            "description":"Count of study in draft mode",
            "format":"int32",
            "example":1
        },
        "testingVersionsCount":{
            "type":"integer",
            "description":"Count of study in testing mode",
            "format":"int32",
            "example":1
        },
        "approvedVersionsCount":{
            "type":"integer",
            "description":"Count of study in approved mode",
            "format":"int32",
            "example":1
        },
        "archivedVersionsCount":{
            "type":"integer",
            "description":"Count of study in archived mode",
            "format":"int32",
            "example":1
        },
        "everApprovedCount":{
            "type":"integer",
            "description":"If study was ever approved",
            "format":"int32",
            "example":1
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Study modes",
                "example":"active",
                "enum":[
                    "test",
                    "training",
                    "active"
                ]
            }
        },
        "customerRefNo":{
            "type":"string",
            "description":"Customer reference number"
        },
        "description":{
            "type":"string",
            "description":"Study description"
        },
        "singleKitSettingId":{
            "type":"string",
            "description":"Single kit id"
        },
        "sowNo":{
            "type":"string",
            "description":"SOW number"
        },
        "sponsorId":{
            "type":"string",
            "description":"Sponsor Id"
        },
        "studyStatusId":{
            "type":"integer",
            "description":"Study status Id",
            "format":"int32"
        },
        "useBlindingGroups":{
            "type":"boolean",
            "description":"Whether study uses blinding groups"
        },
        "useLabelGroups":{
            "type":"boolean",
            "description":"Whether study uses label groups"
        },
        "useShippinggroups":{
            "type":"boolean",
            "description":"Whether study uses shipping groups"
        },
        "previousState":{
            "type":"string",
            "description":"Previous study state",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "studyState":{
            "type":"string",
            "description":"Current study state",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Information about a study for UI consumption."
}

Nested Schema : modes

Type: array

Show Source

• Array of: string
  Allowed Values: [ "test", "training", "active" ]

  Study modes

  Example: active

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Study modes",
        "example":"active",
        "enum":[
            "test",
            "training",
            "active"
        ]
    }
}

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top