Published REST APIs

Published catalog items appear in the dynamic OpenAPI document. Open the explorer at /swagger?urls.primaryName=Dynamic (or Open API Explorer on a Flows section). Choose the Dynamic spec — Static does not list these operations.

Authenticate with Basic (the same host username and password you use in My Credentials) or a Bearer token. An administrator can copy a session token from Admin → Copy API Token after host credentials are saved.

JSON or YAML

Request and response bodies can be YAML as well as JSON. Send Content-Type: application/yaml and the answer comes back as YAML; send JSON and it comes back as JSON. An explicit Accept header overrides either way. The OpenAPI document lists both media types.

Path shapes

• CICS (OL-CICS or CTG) — POST /api/v1/{catalogId}/{endpointName}/{targetName}. The JSON body is the copybook fields. The program or transaction name is the path target. Only published associations appear.
• IMS — the same path shape. Test Transaction still uses the hex editor; the published route takes the copybook JSON body.
• VSAM / datasets — GET /api/v1/{catalogId}/{endpointName}/{logicalName} with limit, skip, and (once filter metadata is loaded) filterExpr. Companion paths after Load metadata: GET …/query-fields and GET …/pk (point-read; repeatable key=layout.field='value' params). The read also accepts a key cursor; an invalid key returns HTTP 400. Fields renamed in View File appear under their new names in the records, the schema and filterExpr.
• Table APIs (DB2 and IMS-DB) — collection /api/v1/{catalogId}/{endpointName}/{schema}/{table}:
  • List — QUERY on the collection (OpenAPI 3.2). When Generate an OpenAPI 3.0-compatible spec is on, the spec advertises GET …/list instead. The router serves GET …/list either way.
  • Count — GET …/count
  • Create — POST on the collection
  • Get / Update / Delete — name each key column as a query parameter, on the collection path or under …/pk

An IMS-DB delete removes the matched segment and every child beneath it.

If a client cannot read OpenAPI 3.1/3.2 query path items or the QUERY method, ask an administrator to turn on Generate an OpenAPI 3.0-compatible spec under Settings → Published API.