Revision as of 16:09, 4 February 2025

ADF ceRecord API Methods

The ADF ceRecord API is a collection of wrapper functions for CommonSpot 11's new RecordSet API. It enables developers to add and update specific customer-defined CommonSpot objects. These new wrapper functions can replace the ADF's apiElement.populateCustom and csContent.populateContent() for updating Global and Local Custom Elements. Additionally, they can be used to update Custom Metadata Forms and Simple Form Elements.

Unlike the extra configuration required to set up the CCAPI, the new ceRecordAPI requires minimal to no configuration. Extra CommonSpot permissions configuration is only needed if the implementation allows data modifications by users with access permissions lower than those set by the element's base security. In these cases, registering the script with CommonSpot's Privileged Modules would be required.

gceRecord

addRecord()

Adds a new record to a Global Custom Element. Arguments:

• ceName - The name of the Global Custom Element where the record will be added.
• dataValues - The field name/value pairs structure for the record to be added.
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • contentUpdateResponse: string (Success:1 or Success:0)
  • contentUpdated: boolean
  • data: struct
  • datapageid: numeric (0 if status=false)
  • error_msg: string
  • errorfields: array
  • status: boolean
  • updatefields: array
  • error_msg: string
  • error: struct (key added only on error)

updateRecord()

Updates an existing record in a Global Custom Element. Arguments:

• ceName - The name of the Global Custom Element where the specified record will be updated.
• dataPageID - The dataPageID value for the record to be updated
• dataValues - The field name/value pairs structure of the record to be updated
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • contentUpdateResponse: string (Success:1 or Success:0)
  • contentUpdated: boolean
  • data: struct
  • datapageid: numeric (0 if status=false)
  • error_msg: string
  • errorfields: array
  • status: boolean
  • updatefields: array
  • error_msg: string
  • error: struct (key added only on error)

saveRecord()

Adds or updates a Global Custom Element record. Updates the record if an existing ‘datapageid’ value greater than 0 is passed in with the dataValues, otherwise it will create a new record. Arguments:

• ceName - The name of the Global Custom Element where the record will be saved.
• dataValues - The field name/value pairs structure for the record to be saved. A ‘dataPageID’ key/value pair must be included to update a specific record.
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • contentUpdateResponse: string (Success:1 or Success:0)
  • contentUpdated: boolean
  • data: struct
  • datapageid: numeric (0 if status=false)
  • error_msg: string
  • errorfields: array
  • status: boolean
  • updatefields: array
  • error_msg: string
  • error: struct (key added only on error)

lceRecord

addRecord()

Creates a new page and adds a new record to a Local Custom Element on the new page. Arguments:

• ceName - The name of the Local Custom Element where the record will be added.
• subsiteid - The subsiteid of subsite where the new page will be created
• templateid - The templateid of the template used to create the new page
• controlid - The controlID value for the element instance where the data will be added
• pageValues - A struct of standard metadata used to create the new page
• dataValues - The field name/value pairs structure for the record to be added.
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).
• activatePage - A boolean flag to set the new page as active or inactive after creation
• useRemoteCreate - A boolean flag used to enable or disable the remote command API for the page creation

Returns:

• Struct:
  • contentUpdateResponse - string (Success:1 or Success:0)
  • contentUpdated - boolean
  • data - struct
  • pageid - numeric (0 if status=false)
  • subsiteid - numeric
  • templateid - numeric
  • controlid - numeric
  • error_msg - string
  • errorfields - array
  • status - boolean
  • updatefields - array
  • error_msg - string
  • error - struct (key added only on error)

updateRecord()

Updates an existing record in a Local Custom Element on a page. Arguments:

• ceName - The name of the Local Custom Element where the specified record will be updated.
• pageID - The pageID value for the page to be updated
• controlid - The controlID value for the element instance to be updated
• dataValues - The fieldname/value pairs structure of the record to be updated
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • contentUpdateResponse - string (Success:1 or Success:0)
  • contentUpdated - boolean
  • data - struct
  • pageid - numeric (0 if status=false)
  • controlid - numeric
  • error_msg- string
  • errorfields - array
  • status - boolean
  • updatefields - array
  • error_msg - string
  • error - struct (key added only on error)

mdfRecord

updateRecord()

Updates a metadata form record bound to a page. Arguments:

• mdFormName - The name of the Custom Metadata From where the specified record will be updated.
• pageID - The pageID value for the page where the metadata record to be added/updated
• dataValues - The fieldname/value pairs structure of the record to be updated
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • contentUpdateResponse: string (Success:1 or Success:0)
  • contentUpdated: boolean
  • data: struct
  • pageid: numeric (0 if status=false)
  • error_msg: string
  • errorfields: array
  • status: boolean
  • updatefields: array
  • error_msg: string
  • error: struct (key added only on error)

sfsRecord

addRecord()

Adds a new record to a Simple Form Element Arguments:

• formName - The name of the Global Custom Element where the record will be added.
• dataValues - The field name/value pairs structure for the record to be added.
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • contentUpdateResponse- string (Success:1 or Success:0)
  • contentUpdated- boolean
  • data- struct
  • datapageid- numeric (0 if status=false)
  • error_msg- string
  • errorfields- array
  • status- boolean
  • updatefields - array
  • error_msg - string
  • error - struct (key added only on error)

updateRecord()

Updates an existing record in a Simple Form Element Arguments:

• formName - The name of the Global Custom Element where the specified record will be updated.
• dataPageID - The dataPageID value for the record to be updated
• dataValues - The field name/value pairs structure of the record to be updated
• fieldSpecs - A field name/specs option pairs structure used to modify the data values expected by the configured field (currently only used for Taxonomy fields).

Returns:

• Struct:
  • content update response - string (Success:1 or Success:0)
  • contentUpdated - boolean
  • data - struct
  • datapageid - numeric (0 if status=false)
  • error_msg - string
  • errorfields - array
  • status - boolean
  • updatefields - array
  • error_msg - string
  • error - struct (key added only on error)