Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/treatments

Retrieves a list of all treatment arms for a randomization design. Rights: DesignerRandListGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• rndDesignId(required): string(uuid)
  ID of the randomization design.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyVersion(required): string
  Version of the study.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• */*

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Treatment
  Contains treatment details.

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

Nested Schema : Treatment

Type: object

Contains treatment details.

Show Source

• comment: string
  Comment

  Example: Some comment
• description: string
  Treatment description

  Example: Treatment description
• externalTreatmentId: string
  External treatment identifier.

  Example: Treatment A
• id: string (uuid)
  ID of the treatment
• objectVersionNumber: number (double)
  Audit trail field that represents the version number of the data.

  Example: 5
• operationType: string
  Allowed Values: [ "CREATED", "MODIFIED" ]

  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: MODIFIED
• reason: string
  Reason

  Example: Some reason
• shortName: string
  Treatment short name

  Example: TxA
• softwareVersionNumber: number (double)
  Software version number

  Example: 5
• srcId: string (uuid)
  Internal ID of treatment
• srcVersionStart: string (date-time)
  Internal version start of treatment
• studyId: string (uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
• studyVersionStart: string (date-time)
  String representing the version of the study. Helps track changes in form or study design.
• treatmentId: string (uuid)
• userId: string (uuid)
  Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the treatment",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"Treatment description",
            "example":"Treatment description"
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"External treatment identifier.",
            "example":"Treatment A"
        },
        "shortName":{
            "type":"string",
            "description":"Treatment short name",
            "example":"TxA"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "format":"date-time"
        },
        "srcId":{
            "type":"string",
            "description":"Internal ID of treatment",
            "format":"uuid"
        },
        "srcVersionStart":{
            "type":"string",
            "description":"Internal version start of treatment",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED",
            "enum":[
                "CREATED",
                "MODIFIED"
            ]
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "format":"double",
            "example":5
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "format":"double",
            "example":5
        },
        "userId":{
            "type":"string",
            "description":"Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason",
            "example":"Some reason"
        },
        "comment":{
            "type":"string",
            "description":"Comment",
            "example":"Some comment"
        },
        "treatmentId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Contains treatment details."
}

404 Response

Study not found. Or randomization design not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested 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 : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top