SAP OData integration

SAP S/4HANA OData API: entity CRUD, function imports, batch, metadata

Help CentreConnectors

Overview

SAP OData is the generic SAP Gateway/Netweaver REST surface – exposes custom + standard OData services. The Automize SAP OData connector is a generic entity-CRUD + function-import + batch + metadata client for any SAP OData service.

  • Regions: Wherever your SAP system runs.
  • Plans: Customer's SAP licensing.

Setting up the connection

Auth type: OAuth 2.0 (Client Credentials).

  1. SAP admin → expose OData service + Communication Arrangement.
  2. OAuth Client Credentials OR Basic auth.
  3. In Automize → Settings → Connectors → SAP OData. Paste credentials + service base URL.

Find your credentials at https://help.sap.com/.


Rate limits

Per-SAP system capacity.


Data model

Generic OData:

    Service ── Entity Sets ── Entities (typed records)
            ├─ Function Imports (custom server methods)
            └─ $metadata (schema)

Available operations

8 operations available. Click any row to jump to its detail.

OperationCategoryWhat it does
Count entitiesGeneralGet the count of entities in an SAP OData entity set.
Create entityGeneralCreate a new entity in an SAP OData service.
Delete entityGeneralDelete an SAP OData entity by key.
Call function importGeneralExecute an SAP OData function import.
Get entityGeneralGet a single SAP OData entity by key.
Get metadataGeneralGet the SAP OData service metadata document ($metadata).
Query entity setGeneralQuery an SAP OData entity set with $filter, $select, $expand, $top, $skip.
Update entityGeneralUpdate an SAP OData entity (MERGE/PATCH).

Operations

Count entities

Get the count of entities in an SAP OData entity set.

ParameterRequiredTypeDescription
Service name serviceYestext
Entity set entity_setYestext

Create entity

Create a new entity in an SAP OData service.

ParameterRequiredTypeDescription
Service name serviceYestext
Entity set entity_setYestext
Fields (JSON) fieldsYestextarea

Tips

  • entity_set + entity (object matching $metadata schema).

Delete entity

Delete an SAP OData entity by key.

ParameterRequiredTypeDescription
Service name serviceYestext
Entity set entity_setYestext
Entity key keyYestext

Tips

  • By primary key.

Call function import

Execute an SAP OData function import.

ParameterRequiredTypeDescription
Service name serviceYestext
Function name function_nameYestext

Get entity

Get a single SAP OData entity by key.

ParameterRequiredTypeDescription
Service name serviceYestext
Entity set entity_setYestext
Entity key keyYestext

Get metadata

Get the SAP OData service metadata document ($metadata).

ParameterRequiredTypeDescription
Service name serviceYestext

Query entity set

Query an SAP OData entity set with $filter, $select, $expand, $top, $skip.

ParameterRequiredTypeDescription
Service name serviceYestext
Entity set entity_setYestext
$filter $filterNotext
$select $selectNotext
$expand $expandNotext
$orderby $orderbyNotext
$top $topNonumber
$skip $skipNonumber

Update entity

Update an SAP OData entity (MERGE/PATCH).

ParameterRequiredTypeDescription
Service name serviceYestext
Entity set entity_setYestext
Entity key keyYestext
Fields (JSON) fieldsYestextarea

Tips

  • key + entity changes. MERGE or PUT.

FAQ

vs the slug-specific SAP connectors?
SAP OData is generic – works for any service. SAP S/4HANA / B1 connectors are pre-shaped for those products. Use generic for custom services or unmapped surfaces.

Related connectors

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.