Custom Field
Use this endpoint to load values to training custom fields at either the Learning Object (LO) level or the Transcript level.
- A maximum of 50 records can be in each request.
- Each request can update either the LO level custom field or the Transcript level Custom field, but not both. In other words, updates for the LO level custom fields and the updates for the Transcript level custom fields must be made in separate API calls.
- Blank values do not overwrite populated values.
Below is a list of custom field types that you can update using this API along with any associated rules:
| Custom Field Type | Field Requirements |
|---|---|
| Checkbox | To check, value must be “true” (without doublequotes) value.To uncheck, value must be "false" (without doublequotes). |
| Date Field | Value must be in the following format: MM-DDYYYY. |
| Dropdown | Value must match one of the field’s dropdownvalues |
| Numeric Field | Value must be a numeric value. Decimals areacceptable. |
| Radio Button | Value must match one of the field’s radio buttonvalues. |
| Scrolling Text Box | Value can be a maximum of 2,000 characters. |
| Short Text Box | Value can be a maximum of 100 characters. |
Permission Required: Training Custom Fields
OAuth 2.0 Scope: training:create
Error Descriptions
Handled Error List
| Error Types | Error Message |
|---|---|
| EmailTag | Email tag is missing |
| ItemType | Invalid item type |
| Object ID | Object ID missing |