Difference between revisions of "CeRecordAPI Reference"

From ADF Docs
Jump to: navigation, search
Line 61: Line 61:
 
Description:
 
Description:
 
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.
 
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.
 +
 +
 +
== lceRecord ==
 +
=== addRecord() ===
 +
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''' -
 +
* '''useRemoteCreate''' -
 +
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)
 +
Description:
 +
* Creates a new page and adds a new record to a Local Custom Element on the new page.
 +
 +
 +
=== updateRecord() ===
 +
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)
 +
Description:
 +
** Updates an existing record in a Local Custom Element on a page.
 +
 +
 +
 +
== mdfRecord ==
 +
 +
updateRecord()
 +
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)
 +
Description:
 +
Updates a metadata form record bound to a page.
 +
 +
== sfsRecord ==
 +
 +
addRecord()
 +
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)
 +
Description:
 +
Adds a new record to a Simple Form Element
 +
updateRecord()
 +
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:
 +
        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)
 +
Description:
 +
Updates an existing record in a Simple Form Element

Revision as of 15:16, 4 February 2025

ADF ceRecord API Methods

gceRecord

addRecord()

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)

Description:

  • Adds a new record to a Global Custom Element.

updateRecord()

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)

Description:

  • Updates an existing record in a Global Custom Element.

saveRecord()

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)

Description: 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.


lceRecord

addRecord()

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 -
  • useRemoteCreate -

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)

Description:

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


updateRecord()

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)

Description:

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


mdfRecord

updateRecord() 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)

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

sfsRecord

addRecord() 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)

Description: Adds a new record to a Simple Form Element updateRecord() 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: 

        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)

Description: Updates an existing record in a Simple Form Element

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=CeRecordAPI_Reference&oldid=8247"