REST API for Clinical One Platform

Get a list of study branches

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/branches

Retrieves a list of branches in a study.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E
version(required): string

Study version. Example: "1.0.0.1"

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object VisitBranchDto v1.0

Title: VisitBranchDto v1.0

Visit Branch details.

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

Nested Schema : VisitBranchDto v1.0

Type: object

Title: VisitBranchDto v1.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
shortName(required): string

Minimum Length: 1

Maximum Length: 32

Visit Branch shortName

Example: Br2
title(required): string

Minimum Length: 1

Maximum Length: 64

Visit Branch title

Example: Branch 2

{
    "title":"VisitBranchDto v1.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"
            }
        }
    },
    "description":"Visit Branch details."
}

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

500 Response

Error

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