Newer Version Available

This content describes an older version of this product. View Latest

ResearchStdyRandomization

Represents the randomization algorithm configuration defined for a research study. This object is available in API version 61.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AlgorithmFlowDefinition
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The flow definition that contains the block generation algorithm.
AlgorithmType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the algorithm type of the research study randomization.
Possible values are:
  • Block
  • Custom
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the research study randomization.
DoesAsgnCandidatesToGroups
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the randomization procedure should create a Research Study Comparison Group Candidate record for candidates for the matching group.
The default value is false.
DoesGenerateBlockOnDemand
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the algorithm can generate new blocks during randomization (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
MaximumBlockSizeMultiplier
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum multiplier that's applied to decide the size of a block type research study randomization.
MinimumBlockSizeMultiplier
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The minimum multiplier that's applied to decide the size of a block type research study randomization.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the research study randomization.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the object assigned to the territory.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
RandomizationLevel
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the randomization level of the research study randomization.
Possible values are:
  • Central
  • Noncentral
ResearchStudyId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The research study associated with the research study randomization.
This field is a relationship field.
Relationship Name
ResearchStudy
Refers To
ResearchStudy
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the research study randomization.
Possible values are:
  • Active
  • Draft
  • Inactive

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ResearchStdyRandomizationFeed
Feed tracking is available for the object.
ResearchStdyRandomizationHistory
History is available for tracked fields of the object.
ResearchStdyRandomizationShare
Sharing is available for the object.