Operation Properties - API Resources tab

COBOL Resource

Each row represents a resource for a COBOL group item in the chosen entry point.

Paths/Methods

The optional relative URI path used to identify the resource associated with its generated operations, and the HTTP methods (GET, POST, PUT, DELETE) that can be used to access the resource. To specify a parameter in the relative URI path, type a curly brace ({) and select an interface field from the list.

The table on this tab contains a resource entry for each COBOL group item in the chosen entry point, with a default path and default selected methods. When you press OK, a new operation is created for each of the selected methods of the selected resources. In general, each resource selection will generate, by default, a GET operation for retrieving the group item and a PUT operation for updating the item. For each COBOL group item with nonzero occurs (i.e. array), two separate resource entries are presented:

• The first entry is for accessing the array resource (i.e. the "collection") as a whole. By default, this resource selection will generate a GET operation for retrieving the entire collection and a POST operation for adding a single element (i.e. a "singleton") to the collection. The GET operation will have an interface field group mapped to, and with the same occurs value as, the COBOL group. The POST operation will also have an interface field group mapped to the COBOL group but with an occurs value of 1.
• The second entry is for accessing a singleton resource within the collection. By default, this resource selection will generate a GET operation for retrieving an item of the collection, a PUT operation for updating an item, and a DELETE operation for removing an item from the collection. Each of these operations will have an interface field group mapped to the COBOL group and with an occurs value of 1, as well as have a Path interface field corresponding to a parameter in the operation's relative URI path. The additional Path field is meant to be used as an index for identifying which item in the collection is to be accessed.