Jump to

• Request
• Response

[Deprecated]: V1.0

post

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

Deprecated: Use latest version instead. 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 (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyVersionVisitDto v1.0
  Title: StudyVersionVisitDto v1.0

  Information about a visit in a study version.

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

Nested Schema : StudyVersionVisitDto v1.0

Type: object

Title: StudyVersionVisitDto v1.0

Information about a visit in a study version.

Show Source

• studyId: string (uuid)
• studyTitle: string
• studyVersion: string
• visitId: string (uuid)
  Visit GUID

{
    "title":"StudyVersionVisitDto v1.0",
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "studyTitle":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Information about a visit in a study version."
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyDesignMapperV1

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

Nested Schema : StudyDesignMapperV1

Type: object

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

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

Back to Top