Generate Research Study Blocks Action

Generate research study randomization block records to link each block with a specific research study comparison group by using the randomization process.

The Generate Research Study Blocks action generates blocks during the design time to verify the randomized assignment of groups and to test the required block multipliers.

This action is available in API version 61.0 and later.

Special Access Rules

The Generate Research Study Blocks action is available in Enterprise and Unlimited Editions with Life Sciences Cloud and the Participant Enrollment Add-On license. Additionally, the org must be enabled with Research Study Randomization.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/generateResearchStudyBlocks

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
researchStudyRandomizationId	string	Required. ID of the research study randomization record that you want to generate the blocks for.
researchStudyTargetCandidateCount	integer	Required. Number of candidates that you want to generate the blocks for.

Outputs

Output	Type	Description
researchStudyRandomizationBlockIds	string	List of generated research study randomization block IDs.

Example

POST

This sample request is for the Generate Research Study Blocks action.

{
  "inputs": [
    {
      "researchStudyRandomizationId": "1Rdxx0000004CguCAE",
      "researchStudyTargetCandidateCount": 10
    }
  ]
}

This sample response is for the Generate Research Study Blocks action.

[
  {
    "actionName": "generateResearchStudyBlocks",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outputValues": {
      "researchStudyRandomizationBlockIds": [
        "1Mtxx0000004CLw",
        "1Mtxx0000004CLx",
        "1Mtxx0000004CLy"
      ]
    },
    "sortOrder": -1,
    "version": 1
  }
]