Creating an API for a Load Collection operation

After you click Next on the first page of the REST API Wizard for a Load Collection operation, the wizard displays a second page. Make these settings:

  1. From the list of Available Properties, select the properties to include in the operation.
    Optionally, to include all properties in the operation, select the Include All Properties option.
  2. Optionally, use the up and down buttons to reorder the Properties To Include list to your liking.
  3. Click Next.
    The next page offers options to specify filter criteria to limit the Load Collection operation.
  4. Optionally, provide one or more of these filter criteria for the operation:
    Filter
    Specify the filter criteria.
    This can be any valid SQL WHERE clause.
    Order By
    Specify one or more properties by which the collection is to be sorted.
    This parameter is a comma-delimited list of properties that specifies the order in which the result set should be sorted. To have a property sorted in descending order, use the DESC keyword after the property name.
    Record Cap
    To limit the number of returns, specify the number of records to return.
    This parameter specifies how many records are to be retrieved in each request. These are the valid values:
    • -1: This specifies that the system default record cap (200) is to be used.
    • 0: This value specifies that all records are to be retrieved, regardless of any record cap settings.
    • Any other positive integer specifies the number of records that are to be retrieved.
      Note: This setting is subject to any system-wide record cap overrides that might be in effect.
    Bookmark
    Specify a bookmark ID.
    Bookmark IDs serve as a reference when you want to get to the next or previous records in a collection.
    Load Type
    This parameter is used for load collection paging. It is used in conjunction with the bookmark parameter.

    To use, specify one of these types:

    • FIRST
    • NEXT
    • PREV
    • LAST
    Post Query Command
    Specify one or more commands for the system to execute (server-side) for every record returned by a Load Collection action.
    District
    When set to True, this parameter specifies that a set of data that represents only distinct combinations of requested properties is to be returned.
    Read-Only
    When set to True, this parameter specifies that the return results are to be marked as "Read Only".
  5. Optionally, to include a custom load method in the query, click Include Custom Load Method Parameters.
    This action launches a modal page on which you can select the custom load method and provide the parameter values, if any, for that method.

    When yoou are finished with this page, to return to the previous page, click Done.

  6. 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.
  7. Return to the last step of Using the REST API Wizard.