Education Cloud Developer Guide

Introduction to Education Cloud
Release Notes
Education Cloud Data Model Overview
Education Cloud Standard Objects
Education Cloud Fields on Standard Objects
Education Cloud Fields on Standard Objects for United Kingdom Compliance and Configuration
Education Cloud Associated Objects
Education Cloud Standard Value Set Names and Standard Picklist Fields
Education Cloud Tooling API Objects
Education Cloud Business APIs
REST Reference
Resources
Request Bodies
Response Bodies
Action Plan
API Error Details
Associated Rule
Course Offering
Course Offering Details
Course Offering Error
Course Offering Schedule
Course Offering Schedule Details
Custom Field
Get Learning
Hold Result Output Items
Hold Setup
Hold Violation
Hold Violation Result
Hold Violation Result Details
Learning
Learning Details
Learning Equivalency Creation
Learning Equivalency Item
Learning Equivalency Result
Learning Foundation Item
Learning Fulfiller
Learnings Mapping
Learning Outcome Item
Learning Status
Manage Learning
Manage Learnings
Mentoring Benefit Assignment
Mentoring Benefit Assignment Details
Task
Fundraising
PDF

Hold Setup

Output representation of the response details to create a hold setup.
JSON example
1{
2  "regulatoryCodeId": "0x8y556ddd",
3  "regulatoryCodeRegClVerId": [
4    "0x8y556dd3",
5    "0x7725ss"
6  ],
7  "aptAssignmentId": "0x5567777d"
8}
Property Name Type Description Filter Group and Version Available Version
aptAssignmentId String Unique ID of the action plan template created for the hold. Big, 64.0 64.0
regulatoryCodeId String Unique ID of the Hold that was setup. Big, 64.0 64.0
regulatory​CodeRegClVerId String[] Unique ID of the regulatory code regulation clause version associated with the hold. Big, 64.0 64.0