Get study branch

get

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

Retrieves a branch in a study.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : VisitBranchDto v2.0
Type: object
Title: VisitBranchDto v2.0
Visit Branch details.
Show Source
Nested Schema : arms
Type: array
Arm Details DTO
Show Source
Nested Schema : forms
Type: array
Form Details DTO
Show Source
Nested Schema : formVisits
Type: array
Visit Details DTO
Show Source
Nested Schema : From Item Advanced Property v11.0
Type: object
Title: From Item Advanced Property v11.0
Form Item Advanced Property
Show Source
Nested Schema : rules
Type: array
Show Source
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
  • For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE
    Example: Yes
  • name
    Example: RolloverQuestionAnswer
  • For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID
    Example: B1B8327AFAA6412287106192AB5984EF

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top