Jump to

• Request
• Response

V1.0

put

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

Update study rule copy status for the targetted study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : StudyCopyStatusDto v1.0

Type: object

Title: StudyCopyStatusDto v1.0

Form Info

Show Source

• copyStatus: string
  Copy status

  Example: Copy Rules in Progress
• studyId: string (uuid)
  Study Unique GUID
• studyVersion: string
  Study version

  Example: 1.0.0.1

{
    "title":"StudyCopyStatusDto v1.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "copyStatus":{
            "type":"string",
            "description":"Copy status",
            "example":"Copy Rules in Progress"
        }
    },
    "description":"Form Info"
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : StudyCopyStatusDto v1.0

Type: object

Title: StudyCopyStatusDto v1.0

Form Info

Show Source

• copyStatus: string
  Copy status

  Example: Copy Rules in Progress
• studyId: string (uuid)
  Study Unique GUID
• studyVersion: string
  Study version

  Example: 1.0.0.1

{
    "title":"StudyCopyStatusDto v1.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "copyStatus":{
            "type":"string",
            "description":"Copy status",
            "example":"Copy Rules in Progress"
        }
    },
    "description":"Form Info"
}

Examples

Select an example successResponse

404 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.

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