REST API for Clinical One Platform

Create all visits, forms and questionnaires

post

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

Creates all the visits, forms and questionnaires for the study ID on one or more study versions.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: object VisitDtoV1

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

Nested Schema : VisitDtoV1

Type: object

Show Source

studyId: string (uuid)
studyTitle: string

Study name

Example: Study 03
version: string

version

Example: 1.3.0.6
versionPreviousStatus: string

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

Previous study status

Example: TESTING
versionStatus: string

Study version status

Example: Active, not recruiting
visitId: string (uuid)

Visit GUID

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object StudyDesignMapperV1

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

Nested Schema : StudyDesignMapperV1

Type: object

500 Response

Error

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.