Creating an API for an Update Collection operation

After you click Next on the first page of the REST API Wizard for an Update Collection operation, the wizard displays a second page.

  1. To define an update action for an item in the IDO, click Add.
    The wizard adds a record to the grid.
  2. To instruct the system to refresh the collection after the operation has completed, select the Refresh After Update option.
  3. From the Action drop-down list, select the operation you want the API to perform.
    These are the available options:
    • Insert - Adds a specified record to the collection.
    • Update - Makes a specified change to a designated record in the collection.
    • Delete - Removes the designated record from the collection.

    If you select the Insert option, the wizard automatically creates the Item ID, based on the IDO. If you select the Update option or the Delete option, you must supply the Item ID.

  4. If you selected Update or Delete, provide the Item ID, if required.

    This is the typical format for the Item ID: PBT=tableName tableAlias.DT=timestamp aa.ID=rowPointer

    where:

    • tableName is the name of the IDO table.
    • tableAlias is the table alias, if any.
    • timestamp is
    • rowPointer is the pointer for the row for the specified item.
  5. In the Update Locking field, specify the update locking mechanism for the item.
    These are the supported options:
    • Row (default)
    • Property
  6. To select properties to include and, optionally, to define for each item, click Modify Properties.
    Clicking this link launches the Update Item Properties page in which you can select and define the properties you want.
    1. To add a property to include, click Add.
    2. From the Property drop-down list, select the property on which to perform the action.
    3. In the grid, specify these values for each property you want to update:
      Property
      From the drop-down list, select the property for which you want to perform the operation.
      Value
      Provide the value of the property.
      Modified
      When selected, this option indicates that the property has been modified.
      Null
      When selected, this option indicates that the property has a null (empty) value.
    4. Optionally, rearrange the list of properties using the up and down arrows to the right of the grid.
    5. When you are finished selecting, defining, and ordering properties, to return to the Update Items page, click Done.
  7. Click Next.
    Tthe wizard displays a summary of both the name of the IDO Swagger document and the base URL and filename of the REST API to be created.
  8. Return to the last step of Using the REST API Wizard.