Custom fields endpoint

This topic provides a quick reference for the method signatures of custom fields API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/config/customfields

WSDL: http://smile.example.com:port/stage/smile/ws/v2/config/customfields?wsdl

Table 1. Custom fields API methods
Method Method signature Purpose
addCollectionEntry()
CustomCollectionEntry addCollectionEntry(
 NewCustomCollectionEntryRequest newEntryRequest)
Creates a new collection entry for a custom collection.
deleteCollectionEntry()
void deleteCollectionEntry(
 int key)
Deletes a custom collection entry.
findCollectionEntry()
CustomCollectionEntrySearchResults findCollectionEntries(
 string collectionCode,
 SearchCondition criteria,
 int limit,
 int offset)
Searches a custom collection custom fields entries that match a given value.
getCollectionEntry()
CustomCollectionEntry getCollectionEntry(
 int key)
Retrieves a custom collection entry directly by key.
getCollectionEntryByEntryCode()
CustomCollectionEntry getCollectionEntryByEntryCode(
 string collectionCode,
 string entryCode)
Retrieves details of a custom collection entry by entry code.
updateCollectionEntry()
void updateCollectionEntry(
 CustomCollectionEntry entry)
Updates an existing custom collection entry.