Jump to

• Request
• Response

V10.0

post

/ec-designer-svc/rest/v10.0/studies/{studyId}/design

Returns visit design details for one or more study versions. Compared with v9.0, this version returns the visit design response shape while retaining lite or full response selection.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• isLiteAPI: boolean
  If true, generate light version of the API. Optional.

  Default Value: true

  Example:

  true

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example createVisitDesignV10Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitBranchDesignDtoV10
  Visit design response grouped by scheduled, branch, and unscheduled visits.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VisitBranchDesignDtoV10"
    }
}

Nested Schema : VisitBranchDesignDtoV10

Type: object

Visit design response grouped by scheduled, branch, and unscheduled visits.

Show Source

• branchVisits: array branchVisits
  Branch visit paths in the requested study version.
• scheduledVisits: array scheduledVisits
  Scheduled visits in the requested study version.
• unscheduledVisits: array unscheduledVisits
  Unscheduled visits in the requested study version.

{
    "type":"object",
    "properties":{
        "scheduledVisits":{
            "type":"array",
            "description":"Scheduled visits in the requested study version.",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV10"
            }
        },
        "branchVisits":{
            "type":"array",
            "description":"Branch visit paths in the requested study version.",
            "items":{
                "type":"array",
                "description":"Branch visit paths in the requested study version.",
                "items":{
                    "$ref":"#/components/schemas/BranchDesignDTOV10"
                }
            }
        },
        "unscheduledVisits":{
            "type":"array",
            "description":"Unscheduled visits in the requested study version.",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV10"
            }
        }
    },
    "description":"Visit design response grouped by scheduled, branch, and unscheduled visits."
}

Nested Schema : branchVisits

Type: array

Branch visit paths in the requested study version.

Show Source

• Array of: array items
  Branch visit paths in the requested study version.

{
    "type":"array",
    "description":"Branch visit paths in the requested study version.",
    "items":{
        "type":"array",
        "description":"Branch visit paths in the requested study version.",
        "items":{
            "$ref":"#/components/schemas/BranchDesignDTOV10"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Scheduled visits in the requested study version.

Show Source

• Array of: object VisitDesignDto v10.0
  Title: VisitDesignDto v10.0

  Visit Design Information

{
    "type":"array",
    "description":"Scheduled visits in the requested study version.",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV10"
    }
}

Nested Schema : unscheduledVisits

Type: array

Unscheduled visits in the requested study version.

Show Source

• Array of: object VisitDesignDto v10.0
  Title: VisitDesignDto v10.0

  Visit Design Information

{
    "type":"array",
    "description":"Unscheduled visits in the requested study version.",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV10"
    }
}

Nested Schema : items

Type: array

Branch visit paths in the requested study version.

Show Source

• Array of: object BranchDesignDTOV10
  Branch Design properties

{
    "type":"array",
    "description":"Branch visit paths in the requested study version.",
    "items":{
        "$ref":"#/components/schemas/BranchDesignDTOV10"
    }
}

Nested Schema : BranchDesignDTOV10

Type: object

Branch Design properties

Show Source

• branch: object VisitBranchDto v2.0
  Title: VisitBranchDto v2.0

  Visit Branch details.
• visits: array visits
  The visits in this branch

{
    "type":"object",
    "properties":{
        "branch":{
            "$ref":"#/components/schemas/VisitBranchDtoV2"
        },
        "visits":{
            "type":"array",
            "description":"The visits in this branch",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV10"
            }
        }
    },
    "description":"Branch Design properties"
}

Nested Schema : VisitBranchDto v2.0

Type: object

Title: VisitBranchDto v2.0

Visit Branch details.

Show Source

• arms: array arms
  Arm Details DTO
• branchIndex: integer (int32)
  index information of the branch in the tier

  Example: 10
• branchTier: integer (int32)
  tier information of the branch

  Example: 10
• cycleCount: number
  number of times a branch can cycle

  Example: 10
• forms: array forms
  Form Details DTO
• formVisits: array formVisits
  Visit Details DTO
• id: string (uuid)
  Visit Branch GUID
• isCycle(required): boolean
  determines if the branch is cyclic or acyclic

  Example: true
• isRestartCycle: boolean
  determines if the branch is cycles needs a restart of the cycle count

  Example: true
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 32

  Visit Branch shortName

  Example: Br2
• startCycle: integer (int32)
  Start Cycle Number
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit Branch title

  Example: Branch 2

{
    "title":"VisitBranchDto v2.0",
    "required":[
        "isCycle",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Branch GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit Branch title",
            "example":"Branch 2"
        },
        "shortName":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Visit Branch shortName",
            "example":"Br2"
        },
        "isCycle":{
            "type":"boolean",
            "description":"determines if the branch is cyclic or acyclic",
            "example":true
        },
        "cycleCount":{
            "type":"number",
            "description":"number of times a branch can cycle",
            "example":10
        },
        "branchTier":{
            "type":"integer",
            "description":"tier information of the branch",
            "format":"int32",
            "example":10
        },
        "branchIndex":{
            "type":"integer",
            "description":"index information of the branch in the tier",
            "format":"int32",
            "example":10
        },
        "arms":{
            "type":"array",
            "description":"Arm Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "forms":{
            "type":"array",
            "description":"Form Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "formVisits":{
            "type":"array",
            "description":"Visit Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "startCycle":{
            "type":"integer",
            "description":"Start Cycle Number",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"boolean",
            "description":"determines if the branch is cycles needs a restart of the cycle count",
            "example":true
        }
    },
    "description":"Visit Branch details."
}

Nested Schema : visits

Type: array

The visits in this branch

Show Source

• Array of: object VisitDesignDto v10.0
  Title: VisitDesignDto v10.0

  Visit Design Information

{
    "type":"array",
    "description":"The visits in this branch",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV10"
    }
}

Nested Schema : arms

Type: array

Arm Details DTO

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Arm Details DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : forms

Type: array

Form Details DTO

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Form Details DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : formVisits

Type: array

Visit Details DTO

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Visit Details DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : From Item Advanced Property v11.0

Type: object

Title: From Item Advanced Property v11.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v11.0",
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov11"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v11.0
  Title: From Item Advanced Property Rule v11.0

  Form Item Advanced Property Rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov11"
    }
}

Nested Schema : From Item Advanced Property Rule v11.0

Type: object

Title: From Item Advanced Property Rule v11.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v11.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : VisitDesignDto v10.0

Type: object

Title: VisitDesignDto v10.0

Visit Design Information

Show Source

• branchId: string (uuid)
  Branch ID (UUID, 32-character uppercase hexadecimal string)
• dispensings: object VisitDesignDispensingDto v10.0
  Title: VisitDesignDispensingDto v10.0

  Visit Design dispensing properties
• endVisitId: string (uuid)
  End visit ID (UUID, 32-character uppercase hexadecimal string)
• eventType: string
  Visit Design event type

  Example: ScreeningVisit
• forms: object VisitDesignAssignedFormsDto v10.0
  Title: VisitDesignAssignedFormsDto v10.0

  Visit Design assigned forms properties
• id: string (uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string)
• randomization: object VisitDesignRandomizationDto v10.0
  Title: VisitDesignRandomizationDto v10.0

  Visit Design randomization properties
• scheduling: object VisitDesignSchedulingDto v10.0
  Title: VisitDesignSchedulingDto v10.0

  Visit Design scheduling properties
• shortName: string
  Visit Design short name

  Example: Week1
• startVisitId: string (uuid)
  Start visit ID (UUID, 32-character uppercase hexadecimal string)
• state: object VisitDesignStateDto v10.0
  Title: VisitDesignStateDto v10.0

  Visit Design state properties
• title: string
  Visit design title

  Example: Week1

{
    "title":"VisitDesignDto v10.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit design title",
            "example":"Week1"
        },
        "eventType":{
            "type":"string",
            "description":"Visit Design event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "type":"string",
            "description":"Visit Design short name",
            "example":"Week1"
        },
        "state":{
            "$ref":"#/components/schemas/VisitDesignStateDtoV10"
        },
        "scheduling":{
            "title":"VisitDesignSchedulingDto v10.0",
            "type":"object",
            "properties":{
                "fromVisitId":{
                    "type":"string",
                    "description":"Source visit ID (UUID, 32-character uppercase hexadecimal string)",
                    "format":"uuid"
                },
                "branchId":{
                    "type":"string",
                    "description":"Branch ID (UUID, 32-character uppercase hexadecimal string)",
                    "format":"uuid"
                },
                "delay":{
                    "$ref":"#/components/schemas/Delay"
                },
                "beforeDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "afterDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "outOfWindowAlert":{
                    "type":"string",
                    "description":"Outside Visit Window Alert",
                    "format":"string",
                    "example":"OFF"
                }
            },
            "description":"Visit Design scheduling properties"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV10"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDTOV10"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV10"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        }
    },
    "description":"Visit Design Information"
}

Nested Schema : VisitDesignDispensingDto v10.0

Type: object

Title: VisitDesignDispensingDto v10.0

Visit Design dispensing properties

Show Source

• advancedDispensationCount: integer (int32)
  Number of advanced dispensation assignments for this visit

  Example: 1
• count: integer (int32)
  Number of dispensation assignments for this visit

  Example: 1
• deviceCount: integer (int32)
  Number of device dispensation assignments for this visit

  Example: 1
• titrationCount: integer (int32)
  Number of titration assignments for this visit

  Example: 1

{
    "title":"VisitDesignDispensingDto v10.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of dispensation assignments for this visit",
            "format":"int32",
            "example":1
        },
        "titrationCount":{
            "type":"integer",
            "description":"Number of titration assignments for this visit",
            "format":"int32",
            "example":1
        },
        "deviceCount":{
            "type":"integer",
            "description":"Number of device dispensation assignments for this visit",
            "format":"int32",
            "example":1
        },
        "advancedDispensationCount":{
            "type":"integer",
            "description":"Number of advanced dispensation assignments for this visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design dispensing properties"
}

Nested Schema : VisitDesignAssignedFormsDto v10.0

Type: object

Title: VisitDesignAssignedFormsDto v10.0

Visit Design assigned forms properties

Show Source

• count: integer (int32)
  Number of forms assigned to this visit

  Example: 1

{
    "title":"VisitDesignAssignedFormsDto v10.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of forms assigned to this visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design assigned forms properties"
}

Nested Schema : VisitDesignRandomizationDto v10.0

Type: object

Title: VisitDesignRandomizationDto v10.0

Visit Design randomization properties

Show Source

• algorithmType: string
  Visit Design allow randomization algorithm type

  Example: Central
• id: string (uuid)
  Randomization ID (UUID, 32-character uppercase hexadecimal string)
• treatmentArms: string
  Visit Design allow randomization treatment arms to be remapped

  Example: Randomized
• type: string
  Visit Design randomization type

  Example: Blinded
• visits: array visits
  Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.

{
    "title":"VisitDesignRandomizationDto v10.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit Design randomization type",
            "example":"Blinded"
        },
        "visits":{
            "type":"array",
            "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
            "example":"55C8628FB6594912B3214E294A5D4E9F",
            "items":{
                "type":"string",
                "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
                "format":"uuid"
            }
        },
        "algorithmType":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"Central"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"Randomized"
        }
    },
    "description":"Visit Design randomization properties"
}

Nested Schema : VisitDesignSchedulingDto v10.0

Type: object

Title: VisitDesignSchedulingDto v10.0

Visit Design scheduling properties

Show Source

• afterDelayWindow: object Delay
  Visit design scheduling before-delay window
• beforeDelayWindow: object Delay
  Visit design scheduling before-delay window
• branchId: string (uuid)
  Branch ID (UUID, 32-character uppercase hexadecimal string)
• delay: object Delay
  Visit design scheduling before-delay window
• fromVisitId: string (uuid)
  Source visit ID (UUID, 32-character uppercase hexadecimal string)
• outOfWindowAlert: string (string)
  Outside Visit Window Alert

  Example: OFF

{
    "title":"VisitDesignSchedulingDto v10.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Source visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/Delay"
        },
        "beforeDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "outOfWindowAlert":{
            "type":"string",
            "description":"Outside Visit Window Alert",
            "format":"string",
            "example":"OFF"
        }
    },
    "description":"Visit Design scheduling properties"
}

Nested Schema : VisitDesignStateDto v10.0

Type: object

Title: VisitDesignStateDto v10.0

Visit Design state properties

Show Source

• dynamic: boolean
  Visit Design dynamic state

  Example: false
• lastRequired: boolean
  Visit Design lastRequired state

  Example: false
• repeating: boolean
  Visit Design repeating state

  Example: false
• required: boolean
  Visit Design required state

  Example: true
• timeLine: integer (int32)
  Timeline position used to show when the visit appears.

  Example: 1

{
    "title":"VisitDesignStateDto v10.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Visit Design dynamic state",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Visit Design repeating state",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Visit Design required state",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Visit Design lastRequired state",
            "example":false
        },
        "timeLine":{
            "type":"integer",
            "description":"Timeline position used to show when the visit appears.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design state properties"
}

Nested Schema : visits

Type: array

Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.

Show Source

• Array of: string(uuid)
  Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.

{
    "type":"array",
    "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
    "example":"55C8628FB6594912B3214E294A5D4E9F",
    "items":{
        "type":"string",
        "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
        "format":"uuid"
    }
}

Example:

55C8628FB6594912B3214E294A5D4E9F

Nested Schema : Delay

Type: object

Visit design scheduling before-delay window

Show Source

• days: integer (int32)
  Minimum Value: 0

  Maximum Value: 365
• hours: integer (int32)
  Minimum Value: 0

  Maximum Value: 24

{
    "type":"object",
    "properties":{
        "days":{
            "maximum":365,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "maximum":24,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Visit design scheduling before-delay window"
}

Examples

Select an example createVisitDesignV10Response

204 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitBranchDesignDtoV10
  Visit design response grouped by scheduled, branch, and unscheduled visits.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VisitBranchDesignDtoV10"
    }
}

Nested Schema : VisitBranchDesignDtoV10

Type: object

Visit design response grouped by scheduled, branch, and unscheduled visits.

Show Source

• branchVisits: array branchVisits
  Branch visit paths in the requested study version.
• scheduledVisits: array scheduledVisits
  Scheduled visits in the requested study version.
• unscheduledVisits: array unscheduledVisits
  Unscheduled visits in the requested study version.

{
    "type":"object",
    "properties":{
        "scheduledVisits":{
            "type":"array",
            "description":"Scheduled visits in the requested study version.",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV10"
            }
        },
        "branchVisits":{
            "type":"array",
            "description":"Branch visit paths in the requested study version.",
            "items":{
                "type":"array",
                "description":"Branch visit paths in the requested study version.",
                "items":{
                    "$ref":"#/components/schemas/BranchDesignDTOV10"
                }
            }
        },
        "unscheduledVisits":{
            "type":"array",
            "description":"Unscheduled visits in the requested study version.",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV10"
            }
        }
    },
    "description":"Visit design response grouped by scheduled, branch, and unscheduled visits."
}

Nested Schema : branchVisits

Type: array

Branch visit paths in the requested study version.

Show Source

• Array of: array items
  Branch visit paths in the requested study version.

{
    "type":"array",
    "description":"Branch visit paths in the requested study version.",
    "items":{
        "type":"array",
        "description":"Branch visit paths in the requested study version.",
        "items":{
            "$ref":"#/components/schemas/BranchDesignDTOV10"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Scheduled visits in the requested study version.

Show Source

• Array of: object VisitDesignDto v10.0
  Title: VisitDesignDto v10.0

  Visit Design Information

{
    "type":"array",
    "description":"Scheduled visits in the requested study version.",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV10"
    }
}

Nested Schema : unscheduledVisits

Type: array

Unscheduled visits in the requested study version.

Show Source

• Array of: object VisitDesignDto v10.0
  Title: VisitDesignDto v10.0

  Visit Design Information

{
    "type":"array",
    "description":"Unscheduled visits in the requested study version.",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV10"
    }
}

Nested Schema : items

Type: array

Branch visit paths in the requested study version.

Show Source

• Array of: object BranchDesignDTOV10
  Branch Design properties

{
    "type":"array",
    "description":"Branch visit paths in the requested study version.",
    "items":{
        "$ref":"#/components/schemas/BranchDesignDTOV10"
    }
}

Nested Schema : BranchDesignDTOV10

Type: object

Branch Design properties

Show Source

• branch: object VisitBranchDto v2.0
  Title: VisitBranchDto v2.0

  Visit Branch details.
• visits: array visits
  The visits in this branch

{
    "type":"object",
    "properties":{
        "branch":{
            "$ref":"#/components/schemas/VisitBranchDtoV2"
        },
        "visits":{
            "type":"array",
            "description":"The visits in this branch",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV10"
            }
        }
    },
    "description":"Branch Design properties"
}

Nested Schema : VisitBranchDto v2.0

Type: object

Title: VisitBranchDto v2.0

Visit Branch details.

Show Source

• arms: array arms
  Arm Details DTO
• branchIndex: integer (int32)
  index information of the branch in the tier

  Example: 10
• branchTier: integer (int32)
  tier information of the branch

  Example: 10
• cycleCount: number
  number of times a branch can cycle

  Example: 10
• forms: array forms
  Form Details DTO
• formVisits: array formVisits
  Visit Details DTO
• id: string (uuid)
  Visit Branch GUID
• isCycle(required): boolean
  determines if the branch is cyclic or acyclic

  Example: true
• isRestartCycle: boolean
  determines if the branch is cycles needs a restart of the cycle count

  Example: true
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 32

  Visit Branch shortName

  Example: Br2
• startCycle: integer (int32)
  Start Cycle Number
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit Branch title

  Example: Branch 2

{
    "title":"VisitBranchDto v2.0",
    "required":[
        "isCycle",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Branch GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit Branch title",
            "example":"Branch 2"
        },
        "shortName":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Visit Branch shortName",
            "example":"Br2"
        },
        "isCycle":{
            "type":"boolean",
            "description":"determines if the branch is cyclic or acyclic",
            "example":true
        },
        "cycleCount":{
            "type":"number",
            "description":"number of times a branch can cycle",
            "example":10
        },
        "branchTier":{
            "type":"integer",
            "description":"tier information of the branch",
            "format":"int32",
            "example":10
        },
        "branchIndex":{
            "type":"integer",
            "description":"index information of the branch in the tier",
            "format":"int32",
            "example":10
        },
        "arms":{
            "type":"array",
            "description":"Arm Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "forms":{
            "type":"array",
            "description":"Form Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "formVisits":{
            "type":"array",
            "description":"Visit Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "startCycle":{
            "type":"integer",
            "description":"Start Cycle Number",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"boolean",
            "description":"determines if the branch is cycles needs a restart of the cycle count",
            "example":true
        }
    },
    "description":"Visit Branch details."
}

Nested Schema : visits

Type: array

The visits in this branch

Show Source

• Array of: object VisitDesignDto v10.0
  Title: VisitDesignDto v10.0

  Visit Design Information

{
    "type":"array",
    "description":"The visits in this branch",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV10"
    }
}

Nested Schema : arms

Type: array

Arm Details DTO

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Arm Details DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : forms

Type: array

Form Details DTO

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Form Details DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : formVisits

Type: array

Visit Details DTO

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Visit Details DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : From Item Advanced Property v11.0

Type: object

Title: From Item Advanced Property v11.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v11.0",
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov11"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v11.0
  Title: From Item Advanced Property Rule v11.0

  Form Item Advanced Property Rule

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov11"
    }
}

Nested Schema : From Item Advanced Property Rule v11.0

Type: object

Title: From Item Advanced Property Rule v11.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v11.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : VisitDesignDto v10.0

Type: object

Title: VisitDesignDto v10.0

Visit Design Information

Show Source

• branchId: string (uuid)
  Branch ID (UUID, 32-character uppercase hexadecimal string)
• dispensings: object VisitDesignDispensingDto v10.0
  Title: VisitDesignDispensingDto v10.0

  Visit Design dispensing properties
• endVisitId: string (uuid)
  End visit ID (UUID, 32-character uppercase hexadecimal string)
• eventType: string
  Visit Design event type

  Example: ScreeningVisit
• forms: object VisitDesignAssignedFormsDto v10.0
  Title: VisitDesignAssignedFormsDto v10.0

  Visit Design assigned forms properties
• id: string (uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string)
• randomization: object VisitDesignRandomizationDto v10.0
  Title: VisitDesignRandomizationDto v10.0

  Visit Design randomization properties
• scheduling: object VisitDesignSchedulingDto v10.0
  Title: VisitDesignSchedulingDto v10.0

  Visit Design scheduling properties
• shortName: string
  Visit Design short name

  Example: Week1
• startVisitId: string (uuid)
  Start visit ID (UUID, 32-character uppercase hexadecimal string)
• state: object VisitDesignStateDto v10.0
  Title: VisitDesignStateDto v10.0

  Visit Design state properties
• title: string
  Visit design title

  Example: Week1

{
    "title":"VisitDesignDto v10.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit design title",
            "example":"Week1"
        },
        "eventType":{
            "type":"string",
            "description":"Visit Design event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "type":"string",
            "description":"Visit Design short name",
            "example":"Week1"
        },
        "state":{
            "$ref":"#/components/schemas/VisitDesignStateDtoV10"
        },
        "scheduling":{
            "title":"VisitDesignSchedulingDto v10.0",
            "type":"object",
            "properties":{
                "fromVisitId":{
                    "type":"string",
                    "description":"Source visit ID (UUID, 32-character uppercase hexadecimal string)",
                    "format":"uuid"
                },
                "branchId":{
                    "type":"string",
                    "description":"Branch ID (UUID, 32-character uppercase hexadecimal string)",
                    "format":"uuid"
                },
                "delay":{
                    "$ref":"#/components/schemas/Delay"
                },
                "beforeDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "afterDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "outOfWindowAlert":{
                    "type":"string",
                    "description":"Outside Visit Window Alert",
                    "format":"string",
                    "example":"OFF"
                }
            },
            "description":"Visit Design scheduling properties"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV10"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDTOV10"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV10"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        }
    },
    "description":"Visit Design Information"
}

Nested Schema : VisitDesignDispensingDto v10.0

Type: object

Title: VisitDesignDispensingDto v10.0

Visit Design dispensing properties

Show Source

• advancedDispensationCount: integer (int32)
  Number of advanced dispensation assignments for this visit

  Example: 1
• count: integer (int32)
  Number of dispensation assignments for this visit

  Example: 1
• deviceCount: integer (int32)
  Number of device dispensation assignments for this visit

  Example: 1
• titrationCount: integer (int32)
  Number of titration assignments for this visit

  Example: 1

{
    "title":"VisitDesignDispensingDto v10.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of dispensation assignments for this visit",
            "format":"int32",
            "example":1
        },
        "titrationCount":{
            "type":"integer",
            "description":"Number of titration assignments for this visit",
            "format":"int32",
            "example":1
        },
        "deviceCount":{
            "type":"integer",
            "description":"Number of device dispensation assignments for this visit",
            "format":"int32",
            "example":1
        },
        "advancedDispensationCount":{
            "type":"integer",
            "description":"Number of advanced dispensation assignments for this visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design dispensing properties"
}

Nested Schema : VisitDesignAssignedFormsDto v10.0

Type: object

Title: VisitDesignAssignedFormsDto v10.0

Visit Design assigned forms properties

Show Source

• count: integer (int32)
  Number of forms assigned to this visit

  Example: 1

{
    "title":"VisitDesignAssignedFormsDto v10.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of forms assigned to this visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design assigned forms properties"
}

Nested Schema : VisitDesignRandomizationDto v10.0

Type: object

Title: VisitDesignRandomizationDto v10.0

Visit Design randomization properties

Show Source

• algorithmType: string
  Visit Design allow randomization algorithm type

  Example: Central
• id: string (uuid)
  Randomization ID (UUID, 32-character uppercase hexadecimal string)
• treatmentArms: string
  Visit Design allow randomization treatment arms to be remapped

  Example: Randomized
• type: string
  Visit Design randomization type

  Example: Blinded
• visits: array visits
  Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.

{
    "title":"VisitDesignRandomizationDto v10.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit Design randomization type",
            "example":"Blinded"
        },
        "visits":{
            "type":"array",
            "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
            "example":"55C8628FB6594912B3214E294A5D4E9F",
            "items":{
                "type":"string",
                "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
                "format":"uuid"
            }
        },
        "algorithmType":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"Central"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"Randomized"
        }
    },
    "description":"Visit Design randomization properties"
}

Nested Schema : VisitDesignSchedulingDto v10.0

Type: object

Title: VisitDesignSchedulingDto v10.0

Visit Design scheduling properties

Show Source

• afterDelayWindow: object Delay
  Visit design scheduling before-delay window
• beforeDelayWindow: object Delay
  Visit design scheduling before-delay window
• branchId: string (uuid)
  Branch ID (UUID, 32-character uppercase hexadecimal string)
• delay: object Delay
  Visit design scheduling before-delay window
• fromVisitId: string (uuid)
  Source visit ID (UUID, 32-character uppercase hexadecimal string)
• outOfWindowAlert: string (string)
  Outside Visit Window Alert

  Example: OFF

{
    "title":"VisitDesignSchedulingDto v10.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Source visit ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch ID (UUID, 32-character uppercase hexadecimal string)",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/Delay"
        },
        "beforeDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "outOfWindowAlert":{
            "type":"string",
            "description":"Outside Visit Window Alert",
            "format":"string",
            "example":"OFF"
        }
    },
    "description":"Visit Design scheduling properties"
}

Nested Schema : VisitDesignStateDto v10.0

Type: object

Title: VisitDesignStateDto v10.0

Visit Design state properties

Show Source

• dynamic: boolean
  Visit Design dynamic state

  Example: false
• lastRequired: boolean
  Visit Design lastRequired state

  Example: false
• repeating: boolean
  Visit Design repeating state

  Example: false
• required: boolean
  Visit Design required state

  Example: true
• timeLine: integer (int32)
  Timeline position used to show when the visit appears.

  Example: 1

{
    "title":"VisitDesignStateDto v10.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Visit Design dynamic state",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Visit Design repeating state",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Visit Design required state",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Visit Design lastRequired state",
            "example":false
        },
        "timeLine":{
            "type":"integer",
            "description":"Timeline position used to show when the visit appears.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design state properties"
}

Nested Schema : visits

Type: array

Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.

Show Source

• Array of: string(uuid)
  Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.

{
    "type":"array",
    "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
    "example":"55C8628FB6594912B3214E294A5D4E9F",
    "items":{
        "type":"string",
        "description":"Visit IDs that use this randomization. UUID, 32-character uppercase hexadecimal strings.",
        "format":"uuid"
    }
}

Example:

55C8628FB6594912B3214E294A5D4E9F

Nested Schema : Delay

Type: object

Visit design scheduling before-delay window

Show Source

• days: integer (int32)
  Minimum Value: 0

  Maximum Value: 365
• hours: integer (int32)
  Minimum Value: 0

  Maximum Value: 24

{
    "type":"object",
    "properties":{
        "days":{
            "maximum":365,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "maximum":24,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Visit design scheduling before-delay window"
}

Examples

Select an example createVisitDesignV10NoContent

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