Jump to

• Request
• Response

V1.0

put

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

Updates a treatment arm for the study version. Use the latest supported arm endpoint in v17.0 for current behavior.

Request

Path Parameters

• armId(required): string
  Arm ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  B1B8327AFAA6412287106192AB5984EF

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

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Supported Media Types

• application/json

Request Body - application/json ()

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

Examples

Select an example updateArmV1Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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

Examples

Select an example updateArmV1Response

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

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

Back to Top