Skip to main content

ADT Contracts Catalog

client.adt.* is a tree of typed REST contracts. Each leaf is a declarative descriptor: HTTP verb + path + schemas for request/response. Invoking client.adt.<ns>.<method>(...) produces an HttpAdapter-driven request, parses the response through an @abapify/adt-schemas schema, and hands you a fully-typed object.

Pipeline​

SAP XSD (W3C)
     ↓ ts-xsd
adt-schemas/generated   ← TypedSchema with parse() / build()
     ↓ @abapify/adt-contracts
adtContract.<ns>.*      ← speci descriptors (method, path, headers, body, responses)
     ↓ @abapify/adt-client
client.adt.<ns>.*       ← inferred, callable methods

Worked example — oo.classes​

import { createAdtClient } from '@abapify/adt-client';

const client = createAdtClient({
  baseUrl: 'https://sap.example.com',
  username: 'USER',
  password: 'pass',
  client: '100',
});

// GET a class (typed via adt-schemas → adtcore/class)
const result = await client.adt.oo.classes.get('ZCL_DEMO');
console.log(result.abapClass?.name, result.abapClass?.description);

// Create a class (POST), body typed against the same schema
await client.adt.oo.classes.post({
  abapClass: { name: 'ZCL_NEW', description: 'hello', language: 'EN' },
});

The get/post/put/delete methods — and the body/response payload shapes — come from packages/adt-contracts/src/adt/oo/classes.ts.

Namespaces​

NamespaceURL rootPage
discovery/sap/bc/adt/discoveryDiscovery
core.http/sap/bc/adt/core/http/...Core HTTP
cts/sap/bc/adt/cts/...CTS
atc/sap/bc/adt/atc/...ATC
aunit/sap/bc/adt/abapunit/...AUnit
oo/sap/bc/adt/oo/...OO
packages/sap/bc/adt/packages/...Packages
programs/sap/bc/adt/programs/...Programs
ddic/sap/bc/adt/ddic/...DDIC
functions/sap/bc/adt/functions/...Functions
system/sap/bc/adt/system/...System
repository/sap/bc/adt/repository/...Repository
bo/sap/bc/adt/bo/...Business Objects
businessservices/sap/bc/adt/businessservices/...Business Services
datapreview/sap/bc/adt/datapreviewData Preview
checkruns/sap/bc/adt/checkrunsCheck Runs
activation/sap/bc/adt/activationActivation
runtime.traces/sap/bc/adt/runtime/traces/...Runtime / Traces
gcts/sap/bc/cts_abapvcs/...gCTS
flp/sap/opu/odata/UI2/PAGE_BUILDER_PERS/...FLP
enhancements/sap/bc/adt/enhancements/...Enhancements

See also​