learningcatalogs
Represents a learning catalog REST API structure
GET
URI
/services/apexrest/v1.0/learningcatalogs/*
Description
Returns learning catalog records based on learning catalog title or learning catalog ID, and optionally custom fields of Learning Catalog object that are passed as parameters in request URL
Input Parameters
ids
Comma-separated Salesforce record IDs of learning catalogs
names
Comma-separated names of learning catalogs, use double quotes for all entries
customfields
Comma-separated API names of custom field to be queried for vanahcm__learning_catalog__c object
Sample Code
// GET Response
[{
"LastModifiedDate": "2016-05-30T06:55:33.000Z",
"LastModifiedById": "00515000006AFf4AAG",
"Id": "a2S15000000wkFkEAI",
"CreatedDate": "2016-05-30T06:55:33.000Z",
"CreatedById": "00515000006AFf4AAG",
"Worker": "a4M15000000Gw5iEAC",
"User": null,
"Status": "Submitted",
"StartDate": "2016-11-02",
"Score": 10,
"PassFail": "Pass",
"OwnerId": "00515000006AFf4AAG",
"Name": "LearningCatalog1",
"LearningUrl": null,
"LearningCatalogType": null,
"LearningCatalog": "a2Q15000000FeONEA0",
"ExternalLearningCourse": "ExternalLearningCourse",
"ExternalLearningCost": 55000,
"DevelopmentPlan": "a1p15000003PyWwAAK",
"Description": "Description",
"CompletionDate": "2017-11-02",
"CustomFields": [{
"Value": "Test Custom Field Text",
"FieldName": "Custom_Field_Text__c"
}, {
"Value": "10",
"FieldName": "Custom_Field_Number__c"
}, {
"Value": "foo@bar.com",
"FieldName": "Custom_Field_Email__c"
}, {
"Value": "2018-11-02 00:00:00",
"FieldName": "Custom_Field_Date__c"
}, {
"Value": "true",
"FieldName": "Custom_Field_Checkbox__c"
}]
}]
POST
URI
/services/apexrest/v1.0/learningcatalogs/*
Description
Insert learning catalog records
Input Parameters
records
Learning catalog records that need to be inserted
Sample Code
// POST Request
{
"records": [{
"Vendor": "Salesforce",
"VendorLocation": "Test Location",
"URL": "http://www.url.com",
"Wed": false,
"Tues": false,
"Thur": false,
"Sun": false,
"StartTime": "10:00:00",
"StartDate": "2016-02-02",
"Sat": false,
"Room": "Test Room",
"Name": "Learning Catalog 1",
"Mon": false,
"MinimumEnrollment": "10",
"MaximumEnrollment": "20",
"LearningType": "a2P15000000iU1c",
"InternalCost": "100",
"Instructor": "00515000006Jsjj",
"Fri": false,
"Facility": "null",
"ExternalCost": "10000",
"EndTime": "12:00:00",
"Description": "Description",
"EndDate": "2016-02-04",
"CustomFields": [{
"FieldName": "Description_Learning_Catalog__c",
"Value": "CustomFieldValue"
}]
}]
}
// POST Response
[
"a1fj000000104slAAI",
"a1fj000000104smAAI"
]
PATCH
URI
/services/apexrest/v1.0/learningcatalogs/*
Description
Insert or update learning catalog records
Input Parameters
records
Learning catalog records that need to be inserted or updated
Sample Code
// PATCH Request
{
"records": [{
"Vendor": "Salesforce",
"VendorLocation": "Updated Test Location",
"URL": "http://www.url.com",
"Wed": false,
"Tues": false,
"Thur": false,
"Sun": false,
"StartTime": "10:00:00",
"StartDate": "2016-02-02",
"Sat": false,
"Room": "Updated Test Room",
"Name": "Updated Learning Catalog 1",
"Mon": false,
"MinimumEnrollment": "10",
"MaximumEnrollment": "20",
"LearningType": "a2P15000000iU1c",
"InternalCost": "100",
"Instructor": "00515000006Jsjj",
"Id": "008v000000OKMAfAAY",
"Fri": false,
"Facility": "null",
"ExternalCost": "10000",
"EndTime": "12:00:00",
"EndDate": "2016-02-04",
"Description": "Description",
"CustomFields": [{
"FieldName": "Description_Learning_Catalog__c",
"Value": "Updated Custom Field Value"
}]
}]
}
// PATCH Response
[
"a1fj000000104slAAI",
"a1fj000000104smAAI"
]