Jump to

• Request
• Response

v1.0

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/studyversions/{version}

Updates a study's version. Rights: OrsImportDesignPost.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• version(required): string
  Version of the study.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : StudyVersionRequest

Type: object

Title: StudyVersionRequest

Request to update study version associations.

Show Source

• newVersion(required): string
  Title: New Version

  Minimum Length: 1

  Maximum Length: 32

  Pattern: ^[0-9]+(\.[0-9]+)*$

  Target study version identifier.

  Example: 2.0
• oldVersion(required): string
  Title: Old Version

  Minimum Length: 1

  Maximum Length: 32

  Pattern: ^[0-9]+(\.[0-9]+)*$

  Existing study version identifier.

  Example: 1.0

{
    "title":"StudyVersionRequest",
    "required":[
        "newVersion",
        "oldVersion"
    ],
    "type":"object",
    "properties":{
        "oldVersion":{
            "title":"Old Version",
            "maxLength":32,
            "minLength":1,
            "pattern":"^[0-9]+(\\.[0-9]+)*$",
            "type":"string",
            "description":"Existing study version identifier.",
            "example":"1.0"
        },
        "newVersion":{
            "title":"New Version",
            "maxLength":32,
            "minLength":1,
            "pattern":"^[0-9]+(\\.[0-9]+)*$",
            "type":"string",
            "description":"Target study version identifier.",
            "example":"2.0"
        }
    },
    "description":"Request to update study version associations."
}

Examples

Select an example Update Study Version Request

Back to Top

Response

Supported Media Types

• application/json

204 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

Examples

Select an example Update Study Version Response

400 Response

Invalid study version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

Examples

Select an example Update Study Version Bad Request Response

404 Response

Study version not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

Examples

Select an example Update Study Version Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

Examples

Select an example Update Study Version Server Error Response

Back to Top