Jump to

• Request
• Response

V1.0

post

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

Creates a tenant-level or study-level welcome message. Submit the welcome text in stringValue. The response returns the stored welcome message ID and text.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• studyId: string(uuid)

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Welcome Request v1.0

Type: object

Title: Welcome Request v1.0

Payload for creating or updating a welcome message. Provide stringValue up to 4000 characters; id is optional and is not required for create or update.

Show Source

• id: string (uuid)
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[0-9A-F]{32}$

  Welcome message ID. UUID, 32-character uppercase hexadecimal string. Optional in requests and returned when a stored welcome message exists.
• stringValue: string
  Maximum Length: 4000

  Welcome message text displayed to users. Optional; maximum 4000 characters. For update requests, a blank value removes the existing message.

  Example: Welcome to Clinical One

{
    "title":"Welcome Request v1.0",
    "type":"object",
    "properties":{
        "id":{
            "maxLength":32,
            "minLength":32,
            "pattern":"^[0-9A-F]{32}$",
            "type":"string",
            "description":"Welcome message ID. UUID, 32-character uppercase hexadecimal string. Optional in requests and returned when a stored welcome message exists.",
            "format":"uuid",
            "nullable":true
        },
        "stringValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Welcome message text displayed to users. Optional; maximum 4000 characters. For update requests, a blank value removes the existing message.",
            "nullable":true,
            "example":"Welcome to Clinical One"
        }
    },
    "description":"Payload for creating or updating a welcome message. Provide stringValue up to 4000 characters; id is optional and is not required for create or update.",
    "example":{
        "stringValue":"Welcome to Clinical One"
    }
}

Example:

{
    "stringValue":"Welcome to Clinical One"
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Welcome Response v1.0

Type: object

Title: Welcome Response v1.0

Welcome message returned by the Welcome APIs.

Show Source

• id: string (uuid)
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[0-9A-F]{32}$

  Welcome message ID. UUID, 32-character uppercase hexadecimal string. Optional in requests and returned when a stored welcome message exists.
• stringValue: string
  Maximum Length: 4000

  Welcome message text displayed to users. Optional; maximum 4000 characters. For update requests, a blank value removes the existing message.

  Example: Welcome to Clinical One

{
    "title":"Welcome Response v1.0",
    "type":"object",
    "properties":{
        "id":{
            "maxLength":32,
            "minLength":32,
            "pattern":"^[0-9A-F]{32}$",
            "type":"string",
            "description":"Welcome message ID. UUID, 32-character uppercase hexadecimal string. Optional in requests and returned when a stored welcome message exists.",
            "format":"uuid",
            "nullable":true
        },
        "stringValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Welcome message text displayed to users. Optional; maximum 4000 characters. For update requests, a blank value removes the existing message.",
            "nullable":true,
            "example":"Welcome to Clinical One"
        }
    },
    "description":"Welcome message returned by the Welcome APIs.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "stringValue":"Welcome to Clinical One"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "stringValue":"Welcome to Clinical One"
}

Examples

Select an example successResponse

400 Response

Bad request.

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top