Jump to

• Request
• Response

V1.0

get

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

Retrieves the history of all versions for a study as of a certain date.

Request

Path Parameters

• asofdate(required): string
  As of date parameter in the format yyyy-mm-ddTHH24:MI:SS

  Example:

  2024-01-15T10:30:00

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

  Example:

  F054C951EB74443C93716CA714AB686E

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 StudyVersionHistoryDto v1.0
  Title: StudyVersionHistoryDto v1.0

  Study Version History

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

Nested Schema : StudyVersionHistoryDto v1.0

Type: object

Title: StudyVersionHistoryDto v1.0

Study Version History

Show Source

• operationType: string
  Type of operation

  Example: CREATED
• previousState: string
  previous state

  Example: DESIGN
• studyId: string (uuid)
  Study GUID
• studyState: string
  State of study

  Example: ACTIVE
• userId: string (uuid)
  user GUID
• version: string
  version

  Example: 1.3.0.6
• versionEnd: string (date-time)
  Version End Time
• versionHistory: string
  Previous version

  Example: 1.3.0.6
• versionStart: string (date-time)
  Version Start Time
• versionStatus: string
  Status of study version

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

  Example: Study03:2.0.0.7
• versionType: string
  Previous status of study version

  Example: OLDDRAFT

{
    "title":"StudyVersionHistoryDto v1.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start Time",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation",
            "example":"CREATED"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "previousState":{
            "type":"string",
            "description":"previous state",
            "example":"DESIGN"
        },
        "userId":{
            "type":"string",
            "description":"user GUID",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End Time",
            "format":"date-time"
        },
        "versionType":{
            "type":"string",
            "description":"Previous status of study version",
            "example":"OLDDRAFT"
        },
        "versionTitle":{
            "type":"string",
            "description":"Name of the latest study version",
            "example":"Study03:2.0.0.7"
        },
        "versionStatus":{
            "type":"string",
            "description":"Status of study version",
            "example":"DRAFT"
        },
        "studyState":{
            "type":"string",
            "description":"State of study",
            "example":"ACTIVE"
        },
        "versionHistory":{
            "type":"string",
            "description":"Previous version",
            "example":"1.3.0.6"
        }
    },
    "description":"Study Version History"
}

Examples

Select an example successResponse

400 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

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