Object External API endpoint parameters

When defining external APIs, you can further define and modify the API endpoint definition to meet your needs.

This table lists and describes parameters, some of which you can set or modify, using the Object External API Endpoints form. That form is only accessible by means of the Object External APIs form, which also displays these parameters in read-only mode.

Attribute Description
Collection Name This parameter is the name of the IDO for which the API was created. It is established at the time the API is created and cannot be changed later.

In the REST API Wizard, this is established in the IDO Name field.

Operation ID This parameter is the name (or ID) that is used as a unique identifier for the API. This ID is used to access the API from the IDO Swagger document and/or in the ION API.
Operation Type This parameter is the type of action that is to be performed by the API. These values correspond with the Action values from the REST API Wizard:
  • G = Get Property Info
  • I = Invoke Method
  • L = Load Collection
  • U = Update Collection
Method This parameter identifies the HTTP(S) method to be used by the API endpoint.
Operation Summary This parameter corresponds to the Operation Description field value from the REST API Wizard.
Properties This parameter is for one or more IDO properties displayed in a comma-delimited list. These are the properties that the API endpoint is to process during the designated operation.
Bookmark This parameter is for the bookmark ID. Bookmark IDs serve as a reference when you want to get to the next or previous records in a collection.

The “bookmark” value uses this format:

<B><P><p>UserId</p></P><D><f>false</f></D><F><v>1</v></F><L><v>2</v></L></B>

where:

  • <B></B> is the bookmark envelope tag.
  • <P></P> is the property name of the primary key.
  • <D></D> is a flag that, if TRUE, specifies that records are to be read in descending order.
  • <f></f> is the value of the <D></D> element (TRUE or FALSE).
  • <F></F> is the first row in the collection.
  • <L></L> is the last row in the collection.
  • <v><v> is the value of the row for the given property name.
Filter This parameter restricts the result set. This can be any valid SQL WHERE clause.
Load Collection 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
Order By 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.
Post Query Command This parameter specifies a method to execute once for each row in the result set after the query is completed.

This is the equivalent of the Mongoose PQ option in Load/Save Overrides and uses the same syntax.

Is Distinct This parameter specifies that a set of data that represents only distinct combinations of requested properties is to be returned.
Read Only This parameter specifies that the return results are to be marked as "Read Only".

When this is set to True, retrieved records do not include the _ItemID property, which can be substantial for update and delete operations.

Record Cap 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.
Method Name This parameter is the name of a custom load method.

This parameter can be used in conjunction with the clmparms parameter.

Method Parameter List This parameter is used for a comma-delimited list of custom load methods parameters.
Refresh After Update This parameter specifies that the IDO collection is to be refreshed after the API operation is completed.
Request Body This parameter displays the contents of the body for the request.