Jump to

• Request
• Response

Create welcome message

post

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

Creates a welcome message.

Request

Path Parameters

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

Query Parameters

• studyId: string(uuid)

Supported Media Types

• */*

Request 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : WelcomeDto

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"
        }
    }
}

500 Response

Error

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