Populate and Publish IMS-DB Table APIs
Populate and Publish IMS-DB Table APIs
Open IMS-DB → Browse to list schemas (PCBs). Expand a schema to load its segments. On each schema header, click Populate APIs to create table REST API definitions.
- Optionally enable Publish immediately after save.
- Select segments and operations: Get by PK, List, Create, Update, Delete, and Count.
- Confirm the hierarchic key — every ancestor’s foreign key, then the segment’s own sequence field. Child writes carry parent keys.
- Optionally attach a COBOL copybook so the body is the decoded segment (
DFSIOSEG_<SEGMENT>) instead of JDBC columns. - Click Add. Add commits only the selected rows (and any staged copybook associations). Closing without Add leaves nothing behind.
List pages use a cursor (IMS Universal JDBC has no OFFSET/LIMIT). Point operations address a row with one required query parameter per key column. An IMS-DB delete removes the matched segment and every child beneath it.
On Catalog → IMS-DB, use the inner Table APIs tab (alongside Record layouts and Flows) to publish, unpublish, or delete definitions. Only published definitions are executable on /api/v1/... and appear in the Dynamic OpenAPI spec.
Collection path: /api/v1/{catalogId}/{endpointName}/{schema}/{table}.
- List is
QUERYon the collection (OpenAPI 3.2). With Generate an OpenAPI 3.0-compatible spec, the spec advertisesGET …/listinstead. - Count is
GET …/count. - Create is
POSTon the collection. - Get, Update, and Delete use query parameters named per key column.
A catalog of type IMS-DB must exist (CoreIQ ships with a default). Copybooks chosen in populate also land under Models.
Create IMS-DB CRUD, list, and count REST APIs with a hierarchic key and optional copybook body.