Jump to

• Request
• Response

Get version of a study

get

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

Retrieves a single version for a specified study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  The Version id

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : VersionDto v1.0

Type: object

Title: VersionDto v1.0

Information about a study version.

Show Source

• id: string (uuid)
  Study GUID
• status: string
  Status of study

  Example: DRAFT
• studyVersion: string
  The study version

  Example: 2.0.0.7
• versionTitle: string
  Name of the latest study version

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

  Example: PROTOCOL_AMENDMENT

{
    "title":"VersionDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"The study version",
            "example":"2.0.0.7"
        },
        "status":{
            "type":"string",
            "description":"Status of study",
            "example":"DRAFT"
        },
        "versionTitle":{
            "type":"string",
            "description":"Name of the latest study version",
            "example":"Study03:2.0.0.7"
        },
        "versionType":{
            "type":"string",
            "description":"Type of study version",
            "example":"PROTOCOL_AMENDMENT"
        }
    },
    "description":"Information about a study version."
}

500 Response

Error

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