Jump to

• Request
• Response

V2.0

get

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

Retrieves list of versions for a specified study.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• nondraftonly: boolean
  Returns non-draft versions only when set to true. Optional.

  Default Value: false

  Example:

  false

• sort: boolean
  Sorts the response by study version start date when set to true. Optional.

  Default Value: false

  Example:

  false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VersionDto v2.0
  Title: VersionDto v2.0

  Information about a study version.

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

Nested Schema : VersionDto v2.0

Type: object

Title: VersionDto v2.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
• versionStart: string (date-time)
  start of study version

  Example: 2020-02-05T19:45:53.687Z
• 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 v2.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"
        },
        "versionStart":{
            "type":"string",
            "description":"start of study version",
            "format":"date-time",
            "example":"2020-02-05T19:45:53.687Z"
        }
    },
    "description":"Information about a study version."
}

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

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