Compensation Plan - Roles REST Endpoints

Sort by

Task Path Method

Compensation Plans/Compensation Plan - Roles

The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.

Create a role

Method: post

Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles

Delete a role

Method: delete

Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}

Get a role

Method: get

Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}

Get all roles

Method: get

Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles

Update a role

Method: patch

Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}