Data change web service reference

To register a data change, or to check status on a data change operation, use the following methods on the DataChangeAPI web service.

DataChangeAPI method

Description

updateDataChangeGosu

Use to register a data change.

Pass the method the following arguments as String objects:

  • The reference ID
  • A human-readable description
  • The Gosu code to run

The method returns the public ID of the new DataChange entity instance.

Note the following:

  • If the data change succeeds with no compile errors, you cannot edit the data change Gosu code. You must re-register the script with a new reference ID to make changes to the code.
  • If the data change was never run, or had compile errors, you can update (edit) and rerun Gosu code with the same reference ID.

discardDataChange

Use to discard a data change that you already registered.

Pass the method a data change reference ID as a String object. You cannot discard a data change that was already run.

getDataChangeResult

Use to review the result of a data change that you already registered.

Pass the method a data change reference ID. The method returns a String object that represents the results in the DataChange entity instance. If running the data change code generated parse errors, the results include the errors.

getDataChangeStatus

Use to view the status of a data change that you already registered.

Pass the method a data change reference ID. The method returns a DataChangeStatus typecode. Valid values include:

  • Open
  • Discarded
  • Executinsg
  • Failed
  • Completed

See also