Assign Candidate to Research Study Group Action

Assign candidates, enrolled in the clinical trials through randomization to research study comparison groups.

This action is available in API version 61.0 and later.

Special Access Rules

The Assign Candidate to Research Study Group 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/assignCndtToResearchStudyGroup

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
`researchStudyCandidateId`	string	Required. ID of the research study candidate record that’s randomly assigned to a research study comparison group.

Outputs

The researchStudyComparisonGroupId parameter is shown in the response body only if one of these conditions is met.

The DoesAsgnCandidatesToGroups field on the ResearchStdyRandomization object is set to false.
The DoesAsgnCandidatesToGroups field is set to true and the user has access to the ResearchStdyCmprGroupCndt object.

Output	Type	Description
`candidateAllocationSourceId`	string	ID of the context object or process that’s used to determine the group to assign a candidate to.
`researchStudyComparisonGroupId`	string	ID of the research study comparison group that’s assigned to a candidate.

Example

POST

This sample request is for the Assign Candidate to Research Study Group action.

1{
2  "inputs": [
3    {
4      "researchStudyCandidateId": "7evxx00000000cjAAA"
5    }
6  ]
7}

This sample response is for the Assign Candidate to Research Study Group action.

1[
2  {
3    "actionName": "assignCndtToResearchStudyGroup",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "researchStudyComparisonGroupId": "1F0xx0000004CSPCA2",
9      "candidateAllocationSourceId": "1LtSG0000002P8n"
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]

See Also