Jump to

• Request
• Response

V1.0

put

/ec-designer-svc/rest/v1.0/studies/welcome

Updates a welcome message.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• studyId: string(uuid)
  Study identifier (UUID, 32-character uppercase hexadecimal string). Optional. When omitted, tenant-level welcome text is used.

  Example:

  00000000000000000000000000000000

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• id: string (string)
  Maximum Length: 4000

  String value

  Example: Welcome to ClinicalOne

{
    "type":"object",
    "properties":{
        "id":{
            "maxLength":4000,
            "type":"string",
            "description":"String value",
            "format":"string",
            "example":"Welcome to ClinicalOne"
        }
    }
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: object

Show Source

• id: string (string)
  Maximum Length: 4000

  String value

  Example: Welcome to ClinicalOne

{
    "type":"object",
    "properties":{
        "id":{
            "maxLength":4000,
            "type":"string",
            "description":"String value",
            "format":"string",
            "example":"Welcome to ClinicalOne"
        }
    }
}

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

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