Approvals
Use this API to fetch and update approvals for users. These approvals are visible in the Cornerstone UI within the Universal Profile page.
The API supports the following approval types:
- Forms
- Goals
- Offer Letters
- Peers
- Requisition Approval
- Requisition Requests
- Training Forms
Service Description
Replace {corpname} with your portal name. For service descriptions in your pilot or stage environments, append '-pilot' or '-stg' respectively to your portal name in the URL.
https://{corpname}.csod.com/services/api/Employee/Help
Get Approval Details
Use this endpoint to fetch all pending approval items for the supported approval types for a given user. Note that the user included in the request must have the required permissions to fetch approval data using this API.
Permissions Required: Request Items - View
OAuth 2.0 Scope: approval:read
Error Descriptions
Handled Error List
| Error Types | Error Message |
|---|---|
| Security object | Provided user does not have Rest Services permissions and/or constraints to perform this operation. |
| Permissions | Requesting user does not have required permissions. |
| userName | Invalid userid. |
| Item Id | Invalid Id Value. |
| ApprovalType | Invalid type. |
| ApprovalAction | Invalid action / Action not supported. |
| No data | No data to process. |
| No Match | No Match Found in Pending Approval. |
| ApprovalAction | Invalid action. |
| ApprovalAction | Invalid action. |
Post Approval Details
Use this endpoint to approve or deny a pending approval item.
- This endpoint can only approve/deny pending items on behalf of the user provided in the URL.
- The user included in the request must have the required permissions to approve/deny pending items.
Valid Approval Type Values:
- FormApproval
- GoalApproval
- OfferLetter
- PeerApproval
- RequisitionApproval
- RequisitionRequest
- TrainingFormApproval
Valid Approval Action Values:
- Approve
- Deny
Permissions Required: Request Items - View
OAuth 2.0 Scope: approval:create
Error Descriptions
Handled Error List
| Error Types | Error Message |
|---|---|
| Security object | Provided user does not have Rest Services permissions and/or constraints to perform this operation. |
| Permissions | Requesting user does not have required permissions. |
| userName | Invalid userid. |
| Item Id | Invalid Id Value. |
| ApprovalType | Invalid type. |
| ApprovalAction | Invalid action / Action not supported. |
| No data | No data to process. |
| No Match | No Match Found in Pending Approval. |
| ApprovalAction | Invalid action. |
| ApprovalAction | Invalid action. |