REST API for Clinical One Platform

Get list of treatment arms for all study versions

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/arms

Retrieves list of treatment arms for all study versions.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

includeAllSubjects: boolean

Include dummy entry for all subjects along with all treatment arms.

Default Value: false
mode(required): string

Study mode to filter arms.

Allowed Values: [ "test", "training", "active" ]

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 ArmDto v1.0

Title: ArmDto v1.0

Treatment arm details.

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

Nested Schema : ArmDto v1.0

Type: object

Title: ArmDto v1.0

Treatment arm details.

Show Source

description: string

Minimum Length: 0

Maximum Length: 4000

Treatment Arm Description

Example: Monad NP (60ml) Syrup
id: string (uuid)

Treatment Arm GUID
shortName(required): string

Minimum Length: 1

Maximum Length: 64

Treatment Arm Short Name

Example: Drug
studyId: string (uuid)

Study ID
studyVersionEnd: string (date-time)

Study Version End

Example: 3099-12-31T05:00:00Z
studyVersionStart: string (date-time)

Study Version Start
title(required): string

Minimum Length: 1

Maximum Length: 64

Treatment Arm Title

Example: TxA
versionEnd: string (date-time)

Version End

Example: 3099-12-31T05:00:00Z
versionStart: string (date-time)

Version Start

{
    "title":"ArmDto v1.0",
    "required":[
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Treatment Arm Title",
            "example":"TxA"
        },
        "shortName":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Treatment Arm Short Name",
            "example":"Drug"
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Treatment Arm Description",
            "example":"Monad NP (60ml) Syrup"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        },
        "studyId":{
            "type":"string",
            "description":"Study ID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study Version Start",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "description":"Study Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        }
    },
    "description":"Treatment arm details."
}

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}