REST API for Clinical One Platform

Get all active factors in a study

get

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

Retrieves a list of Study factors. You can retrieve this list by study mode and RandType.

Request

Path Parameters

studyId(required): string(uuid)

Query Parameters

mode(required): string

Study version mode to filter factors.

Allowed Values: [ "test", "training", "active" ]
type(required): string

Rand Algorithim to filter factors.

Default Value: ALL

Allowed Values: [ "stratum", "cohort", "minimization", "all" ]

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 Randomization Factor Details v1.0

Title: Randomization Factor Details v1.0

Randomization Factors DTO

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

Nested Schema : Randomization Factor Details v1.0

Type: object

Title: Randomization Factor Details v1.0

Randomization Factors DTO

Show Source

details: object RandomizationDetails v4.0

Title: RandomizationDetails v4.0

Details of the randomization design.
groups: object RandomizationFactorGroupDto v1.0

Title: RandomizationFactorGroupDto v1.0

RandomizationFactorGroupDto Info

{
    "title":"Randomization Factor Details v1.0",
    "type":"object",
    "properties":{
        "details":{
            "$ref":"#/components/schemas/RandomizationDetailsV4"
        },
        "groups":{
            "title":"RandomizationFactorGroupDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Stratum or Cohort Unique GUID",
                    "format":"uuid"
                },
                "formTitle":{
                    "type":"string",
                    "description":"formTitle",
                    "example":"Demography"
                },
                "questionTitle":{
                    "type":"string",
                    "description":"questionTitle",
                    "example":"Age"
                },
                "groupName":{
                    "type":"string",
                    "description":"Stratum or Cohort GroupName",
                    "example":"Group Name 1"
                },
                "groupId":{
                    "type":"string",
                    "description":" Rand Stratum Factor Id",
                    "format":"uuid"
                }
            },
            "description":"RandomizationFactorGroupDto Info"
        }
    },
    "description":"Randomization Factors DTO"
}

Nested Schema : RandomizationDetails v4.0

Type: object

Title: RandomizationDetails v4.0

Details of the randomization design.

Show Source

algorithm(required): string

Allowed Values: [ "NONE", "CENTRAL", "CENTRAL_STRATIFIED", "SITE_BLOCKED_FIXED", "SITE_BLOCKED_FIXED_STRATIFIED", "SITE_BLOCKED_DYNAMIC", "SITE_BLOCKED_DYNAMIC_STRATIFIED", "COUNTRY_BLOCKED_FIXED", "COUNTRY_BLOCKED_FIXED_STRATIFIED", "COUNTRY_BLOCKED_DYNAMIC", "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED", "REGION_BLOCKED_FIXED", "REGION_BLOCKED_FIXED_STRATIFIED", "REGION_BLOCKED_DYNAMIC", "REGION_BLOCKED_DYNAMIC_STRATIFIED", "MINIMIZATION" ]

The algorithm of the randomization design

Example: Central
cohortType(required): string

Allowed Values: [ "NoCohort", "Adaptive", "Demography", "invalid" ]

The cohort type of the randomization design

Example: None
description: string

Minimum Length: 0

Maximum Length: 4000

Randomization Design Description

Example: Method to assign study participants to a treatment group.
randomizationType(required): string

Allowed Values: [ "Blinded", "Unblinded", "invalid" ]

Type of the randomization design

Example: Blinded
reRandomization: boolean

Whether to use re-randomization on the randomization design

Example: true
title(required): string

Minimum Length: 1

Maximum Length: 64

Randomization Title

Example: Rand 001
treatmentArms: string

Allowed Values: [ "Randomized", "Mapped", "None", "invalid" ]

Whether to use randomized or mapped on the randomization design

Example: Randomized

{
    "title":"RandomizationDetails v4.0",
    "required":[
        "algorithm",
        "cohortType",
        "randomizationType",
        "title"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Randomization Title",
            "example":"Rand 001"
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Randomization Design Description",
            "example":"Method to assign study participants to a treatment group."
        },
        "algorithm":{
            "type":"string",
            "description":"The algorithm of the randomization design",
            "example":"Central",
            "enum":[
                "NONE",
                "CENTRAL",
                "CENTRAL_STRATIFIED",
                "SITE_BLOCKED_FIXED",
                "SITE_BLOCKED_FIXED_STRATIFIED",
                "SITE_BLOCKED_DYNAMIC",
                "SITE_BLOCKED_DYNAMIC_STRATIFIED",
                "COUNTRY_BLOCKED_FIXED",
                "COUNTRY_BLOCKED_FIXED_STRATIFIED",
                "COUNTRY_BLOCKED_DYNAMIC",
                "COUNTRY_BLOCKED_DYNAMIC_STRATIFIED",
                "REGION_BLOCKED_FIXED",
                "REGION_BLOCKED_FIXED_STRATIFIED",
                "REGION_BLOCKED_DYNAMIC",
                "REGION_BLOCKED_DYNAMIC_STRATIFIED",
                "MINIMIZATION"
            ]
        },
        "cohortType":{
            "type":"string",
            "description":"The cohort type of the randomization design",
            "example":"None",
            "enum":[
                "NoCohort",
                "Adaptive",
                "Demography",
                "invalid"
            ]
        },
        "randomizationType":{
            "type":"string",
            "description":"Type of the randomization design",
            "example":"Blinded",
            "enum":[
                "Blinded",
                "Unblinded",
                "invalid"
            ]
        },
        "reRandomization":{
            "type":"boolean",
            "description":"Whether to use re-randomization on the randomization design",
            "example":true
        },
        "treatmentArms":{
            "type":"string",
            "description":"Whether to use randomized or mapped on the randomization design",
            "example":"Randomized",
            "enum":[
                "Randomized",
                "Mapped",
                "None",
                "invalid"
            ]
        }
    },
    "description":"Details of the randomization design."
}

Nested Schema : RandomizationFactorGroupDto v1.0

Type: object

Title: RandomizationFactorGroupDto v1.0

RandomizationFactorGroupDto Info

Show Source

formTitle: string

formTitle

Example: Demography
groupId: string (uuid)

Rand Stratum Factor Id
groupName: string

Stratum or Cohort GroupName

Example: Group Name 1
id: string (uuid)

Stratum or Cohort Unique GUID
questionTitle: string

questionTitle

Example: Age

{
    "title":"RandomizationFactorGroupDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Stratum or Cohort Unique GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"formTitle",
            "example":"Demography"
        },
        "questionTitle":{
            "type":"string",
            "description":"questionTitle",
            "example":"Age"
        },
        "groupName":{
            "type":"string",
            "description":"Stratum or Cohort GroupName",
            "example":"Group Name 1"
        },
        "groupId":{
            "type":"string",
            "description":" Rand Stratum Factor Id",
            "format":"uuid"
        }
    },
    "description":"RandomizationFactorGroupDto Info"
}

500 Response

Error

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