Jump to

• Request
• Response

V1.0

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 (UUID, 32-character uppercase hexadecimal string). Required. Example: F054C951EB74443C93716CA714AB686E

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• includeAllSubjects: boolean
  Include dummy entry for all subjects along with all treatment arms. Optional.

  Default Value: false

  Example:

  false

• mode(required): string
  Study mode to filter arms.

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

  Example:

  test

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RespArmDtoWithStudyVersion

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

Nested Schema : RespArmDtoWithStudyVersion

Type: object

Show Source

• description: string
  Title: Treatment Arm Description

  Minimum Length: 0

  Maximum Length: 4000

  Optional description of the treatment arm. Length: 0 to 4000 characters.

  Example: Investigational treatment arm
• id: string (uuid)
  Title: Treatment Arm ID

  Minimum Length: 32

  Maximum Length: 32

  Treatment arm ID. UUID, 32-character uppercase hexadecimal string. For update requests, use the armId path parameter.
• shortName(required): string
  Title: Treatment Arm Short Name

  Minimum Length: 1

  Maximum Length: 64

  Short name used to identify the treatment arm. Required for create and update requests. Length: 1 to 64 characters.

  Example: ARM_A
• studyId: string (uuid)
  Title: Study ID

  Minimum Length: 32

  Maximum Length: 32

  Study ID. UUID, 32-character uppercase hexadecimal string. Included in responses when available.
• studyVersion: string
  Study version of the study in which treatment arm belongs

  Example: 1.0.0.1
• studyVersionEnd: string (date-time)
  Title: Study Version End

  Date and time when the associated study version ends. Included in responses when available.

  Example: 3099-12-31T05:00:00Z
• studyVersionStart: string (date-time)
  Title: Study Version Start

  Date and time when the associated study version starts. Included in responses when available.

  Example: 2024-01-15T10:30:00Z
• title(required): string
  Title: Treatment Arm Title

  Minimum Length: 1

  Maximum Length: 64

  Treatment arm title. Required for create and update requests. Length: 1 to 64 characters.

  Example: Treatment Arm A
• versionEnd: string (date-time)
  Title: Version End

  Date and time when this treatment arm version ends. Included in responses when available.

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

  Example: 2018-11-23T08:43:01.7Z

{
    "required":[
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Treatment Arm ID",
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Treatment arm ID. UUID, 32-character uppercase hexadecimal string. For update requests, use the armId path parameter.",
            "format":"uuid"
        },
        "title":{
            "title":"Treatment Arm Title",
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Treatment arm title. Required for create and update requests. Length: 1 to 64 characters.",
            "example":"Treatment Arm A"
        },
        "shortName":{
            "title":"Treatment Arm Short Name",
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Short name used to identify the treatment arm. Required for create and update requests. Length: 1 to 64 characters.",
            "example":"ARM_A"
        },
        "description":{
            "title":"Treatment Arm Description",
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Optional description of the treatment arm. Length: 0 to 4000 characters.",
            "nullable":true,
            "example":"Investigational treatment arm"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Date and time when this treatment arm version ends. Included in responses when available.",
            "format":"date-time",
            "nullable":true,
            "example":"3099-12-31T05:00:00Z"
        },
        "studyId":{
            "title":"Study ID",
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Study ID. UUID, 32-character uppercase hexadecimal string. Included in responses when available.",
            "format":"uuid",
            "nullable":true
        },
        "studyVersionStart":{
            "title":"Study Version Start",
            "type":"string",
            "description":"Date and time when the associated study version starts. Included in responses when available.",
            "format":"date-time",
            "nullable":true,
            "example":"2024-01-15T10:30:00Z"
        },
        "studyVersionEnd":{
            "title":"Study Version End",
            "type":"string",
            "description":"Date and time when the associated study version ends. Included in responses when available.",
            "format":"date-time",
            "nullable":true,
            "example":"3099-12-31T05:00:00Z"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version of the study in which treatment arm belongs",
            "example":"1.0.0.1"
        }
    }
}

Examples

Select an example successResponse

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