REST API for Clinical One Cloud Service

V5.0

put

/ec-designer-svc/rest/v5.0/studies/{studyId}

Updates an existing study.

Request

Path Parameters

studyId(required): string(uuid)
Study ID (UUID, 32-character uppercase hexadecimal string). Required. Example: F054C951EB74443C93716CA714AB686E
Example:
```
2F9A6C7E1B8F4D56A23C9F3A0C7D4E11
```
version(required): string
Study version path segment. Required. Example: "1.0.0.1".
Example:
```
1.0.0.1
```

Supported Media Types

application/json

Root Schema : StudyDto v7.0

Type: object

Title: StudyDto v7.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
companies: array companies

Companies list who sponsor the study
companyLabels: array companyLabels

Company labels associated with the study
contractCode: string

Study contract code or identifier

Example: NCT00000419
customerRefNo: string

Customer reference number

Example: CRN-1001
description: string

Study description

Example: A randomized double blind placebo controlled study.
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)

Last modified timestamp

Example: 2026-02-21T06:30:00Z
modes: array modes
narrativeSettings: string

Narrative settings

Example: Send Full Narrative (Editable)
openLabelBlinded: string

Study type for open label and blinded

Example: DoubleBlinded
previousState: string

Allowed Values: [ "settings, active, design, test, training" ]

Previous study state

Example: design
safetyCase: integer (int32)

Safety case

Example: 1
safetyIntegration: boolean

Safety Integration

Example: true
singleKitSettingId: string

Single kit id

Example: KIT-001
sourceStudyId: string (uuid)

Study Unique GUID
sourceStudyTitle: string (string)

Source study title

Example: The study
sourceStudyVersion: string (string)

Source study version

Example: 1.0.0.1
sowNo: string

SOW number

Example: SOW-2026-100
sponsorId: string

Sponsor Id

Example: SPONSOR-001
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

Example: active
studyStatus: string

Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

Current study status

Example: APPROVED
studyStatusId: integer (int32)

Study status Id

Example: 473
studyTitle: string

Study Title or protocol number

Example: TICIPS001
systemCodeListId: string (uuid)

System Code List GUID
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

Example: false
useLabelGroups: boolean

Whether study uses label groups

Example: false
useShippinggroups: boolean

Whether study uses shipping groups

Example: false
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 v7.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
        },
        "sourceStudyId":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string",
            "description":"Source study version",
            "format":"string",
            "example":"1.0.0.1"
        },
        "sourceStudyTitle":{
            "type":"string",
            "description":"Source study title",
            "format":"string",
            "example":"The study"
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Study modes",
                "example":"active",
                "enum":[
                    "test",
                    "training",
                    "active"
                ]
            }
        },
        "customerRefNo":{
            "type":"string",
            "description":"Customer reference number",
            "example":"CRN-1001"
        },
        "description":{
            "type":"string",
            "description":"Study description",
            "example":"A randomized double blind placebo controlled study."
        },
        "singleKitSettingId":{
            "type":"string",
            "description":"Single kit id",
            "example":"KIT-001"
        },
        "sowNo":{
            "type":"string",
            "description":"SOW number",
            "example":"SOW-2026-100"
        },
        "sponsorId":{
            "type":"string",
            "description":"Sponsor Id",
            "example":"SPONSOR-001"
        },
        "studyStatusId":{
            "type":"integer",
            "description":"Study status Id",
            "format":"int32",
            "example":473
        },
        "useBlindingGroups":{
            "type":"boolean",
            "description":"Whether study uses blinding groups",
            "example":false
        },
        "useLabelGroups":{
            "type":"boolean",
            "description":"Whether study uses label groups",
            "example":false
        },
        "useShippinggroups":{
            "type":"boolean",
            "description":"Whether study uses shipping groups",
            "example":false
        },
        "previousState":{
            "type":"string",
            "description":"Previous study state",
            "example":"design",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "studyState":{
            "type":"string",
            "description":"Current study state",
            "example":"active",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "lastModified":{
            "type":"string",
            "description":"Last modified timestamp",
            "format":"date-time",
            "example":"2026-02-21T06:30:00Z"
        },
        "systemCodeListId":{
            "type":"string",
            "description":"System Code List GUID",
            "format":"uuid"
        },
        "companies":{
            "type":"array",
            "description":"Companies list who sponsor the study",
            "example":"ABC Pharma",
            "items":{
                "type":"string",
                "description":"Companies list who sponsor the study",
                "example":"ABC Pharma"
            }
        },
        "companyLabels":{
            "type":"array",
            "description":"Company labels associated with the study",
            "example":"ABC Pharma",
            "items":{
                "type":"string",
                "description":"Company labels associated with the study",
                "example":"ABC Pharma"
            }
        },
        "safetyCase":{
            "type":"integer",
            "description":"Safety case",
            "format":"int32",
            "example":1
        },
        "narrativeSettings":{
            "type":"string",
            "description":"Narrative settings",
            "example":"Send Full Narrative (Editable)"
        },
        "safetyIntegration":{
            "type":"boolean",
            "description":"Safety Integration",
            "example":true
        }
    },
    "description":"Information about a study for UI consumption."
}

Nested Schema : companies

Type: array

Companies list who sponsor the study

Show Source

Array of: string

Companies list who sponsor the study

Example: ABC Pharma

{
    "type":"array",
    "description":"Companies list who sponsor the study",
    "example":"ABC Pharma",
    "items":{
        "type":"string",
        "description":"Companies list who sponsor the study",
        "example":"ABC Pharma"
    }
}

Example:

ABC Pharma

Nested Schema : companyLabels

Type: array

Company labels associated with the study

Show Source

Array of: string

Company labels associated with the study

Example: ABC Pharma

{
    "type":"array",
    "description":"Company labels associated with the study",
    "example":"ABC Pharma",
    "items":{
        "type":"string",
        "description":"Company labels associated with the study",
        "example":"ABC Pharma"
    }
}

Example:

ABC Pharma

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"
        ]
    }
}

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : StudyDto v7.0

Type: object

Title: StudyDto v7.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
companies: array companies

Companies list who sponsor the study
companyLabels: array companyLabels

Company labels associated with the study
contractCode: string

Study contract code or identifier

Example: NCT00000419
customerRefNo: string

Customer reference number

Example: CRN-1001
description: string

Study description

Example: A randomized double blind placebo controlled study.
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)

Last modified timestamp

Example: 2026-02-21T06:30:00Z
modes: array modes
narrativeSettings: string

Narrative settings

Example: Send Full Narrative (Editable)
openLabelBlinded: string

Study type for open label and blinded

Example: DoubleBlinded
previousState: string

Allowed Values: [ "settings, active, design, test, training" ]

Previous study state

Example: design
safetyCase: integer (int32)

Safety case

Example: 1
safetyIntegration: boolean

Safety Integration

Example: true
singleKitSettingId: string

Single kit id

Example: KIT-001
sourceStudyId: string (uuid)

Study Unique GUID
sourceStudyTitle: string (string)

Source study title

Example: The study
sourceStudyVersion: string (string)

Source study version

Example: 1.0.0.1
sowNo: string

SOW number

Example: SOW-2026-100
sponsorId: string

Sponsor Id

Example: SPONSOR-001
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

Example: active
studyStatus: string

Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

Current study status

Example: APPROVED
studyStatusId: integer (int32)

Study status Id

Example: 473
studyTitle: string

Study Title or protocol number

Example: TICIPS001
systemCodeListId: string (uuid)

System Code List GUID
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

Example: false
useLabelGroups: boolean

Whether study uses label groups

Example: false
useShippinggroups: boolean

Whether study uses shipping groups

Example: false
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 v7.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
        },
        "sourceStudyId":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string",
            "description":"Source study version",
            "format":"string",
            "example":"1.0.0.1"
        },
        "sourceStudyTitle":{
            "type":"string",
            "description":"Source study title",
            "format":"string",
            "example":"The study"
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Study modes",
                "example":"active",
                "enum":[
                    "test",
                    "training",
                    "active"
                ]
            }
        },
        "customerRefNo":{
            "type":"string",
            "description":"Customer reference number",
            "example":"CRN-1001"
        },
        "description":{
            "type":"string",
            "description":"Study description",
            "example":"A randomized double blind placebo controlled study."
        },
        "singleKitSettingId":{
            "type":"string",
            "description":"Single kit id",
            "example":"KIT-001"
        },
        "sowNo":{
            "type":"string",
            "description":"SOW number",
            "example":"SOW-2026-100"
        },
        "sponsorId":{
            "type":"string",
            "description":"Sponsor Id",
            "example":"SPONSOR-001"
        },
        "studyStatusId":{
            "type":"integer",
            "description":"Study status Id",
            "format":"int32",
            "example":473
        },
        "useBlindingGroups":{
            "type":"boolean",
            "description":"Whether study uses blinding groups",
            "example":false
        },
        "useLabelGroups":{
            "type":"boolean",
            "description":"Whether study uses label groups",
            "example":false
        },
        "useShippinggroups":{
            "type":"boolean",
            "description":"Whether study uses shipping groups",
            "example":false
        },
        "previousState":{
            "type":"string",
            "description":"Previous study state",
            "example":"design",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "studyState":{
            "type":"string",
            "description":"Current study state",
            "example":"active",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "lastModified":{
            "type":"string",
            "description":"Last modified timestamp",
            "format":"date-time",
            "example":"2026-02-21T06:30:00Z"
        },
        "systemCodeListId":{
            "type":"string",
            "description":"System Code List GUID",
            "format":"uuid"
        },
        "companies":{
            "type":"array",
            "description":"Companies list who sponsor the study",
            "example":"ABC Pharma",
            "items":{
                "type":"string",
                "description":"Companies list who sponsor the study",
                "example":"ABC Pharma"
            }
        },
        "companyLabels":{
            "type":"array",
            "description":"Company labels associated with the study",
            "example":"ABC Pharma",
            "items":{
                "type":"string",
                "description":"Company labels associated with the study",
                "example":"ABC Pharma"
            }
        },
        "safetyCase":{
            "type":"integer",
            "description":"Safety case",
            "format":"int32",
            "example":1
        },
        "narrativeSettings":{
            "type":"string",
            "description":"Narrative settings",
            "example":"Send Full Narrative (Editable)"
        },
        "safetyIntegration":{
            "type":"boolean",
            "description":"Safety Integration",
            "example":true
        }
    },
    "description":"Information about a study for UI consumption."
}

Nested Schema : companies

Type: array

Companies list who sponsor the study

Show Source

Array of: string

Companies list who sponsor the study

Example: ABC Pharma

{
    "type":"array",
    "description":"Companies list who sponsor the study",
    "example":"ABC Pharma",
    "items":{
        "type":"string",
        "description":"Companies list who sponsor the study",
        "example":"ABC Pharma"
    }
}

Example:

ABC Pharma

Nested Schema : companyLabels

Type: array

Company labels associated with the study

Show Source

Array of: string

Company labels associated with the study

Example: ABC Pharma

{
    "type":"array",
    "description":"Company labels associated with the study",
    "example":"ABC Pharma",
    "items":{
        "type":"string",
        "description":"Company labels associated with the study",
        "example":"ABC Pharma"
    }
}

Example:

ABC Pharma

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"
        ]
    }
}

Examples

404 Response

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

Root 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 : details

Type: object

500 Response

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

Root 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 : details

Type: object