The Integration Cockpit API enables programmatic access to your integration landscape data through HTTPS-based JSON access. Query inventory data, monitor traffic patterns and manage integration objects using SQL-like syntax.
Important: All JSON examples use placeholder data for illustration. Your actual API responses contain your specific integration names, IDs and data from your Integration Cockpit instance.
Quick Navigation
New to the API? Start with API Setup → Postman Collection → Essential Operations
Ready for advanced scenarios? Jump to Advanced Operations | Working with the API
Need reference information? See API Reference | Entity Reference | Integration Types | Troubleshooting
API Setup
Complete API setup in 4 simple steps to get your collection working.
Prerequisites
-
Administrator access to WHINT Integration Cockpit
-
Access to Settings → Connectivity → Data Sources
-
HTTP client (Postman recommended)
-
Basic JSON understanding
Step 1: Create API Data Source
-
Navigate to Settings → Connectivity → Data Sources.
-
Click “+” Add.
-
Enter the required values:
-
Name: e.g.
API -
Type:
API -
Environment: e.g.
Production
-
-
Click “Save”.
Step 2: Get Your API Endpoint
After saving, the Connection Details section displays your complete API endpoint URL.
Your complete API endpoint (example):
https://your-instance.cfapps.eu10.hana.ondemand.com/api
Note: Your actual URL will be different based on your Integration Cockpit instance
For Postman Collection Users: You only need the base URL portion without https:// or /api (copy this to {{WHINT_BASE_URL}}):
your-instance.cfapps.eu10.hana.ondemand.com
Note: Your actual base URL will be different - use only your instance domain
This base URL goes into the {{WHINT_BASE_URL}} variable in the Postman collection.
For manual API requests: Copy and save the complete URL above - you'll use it for all direct API requests.
Step 3: Generate Access Token
In the Authentication section:
-
Type:
ACCESSTOKEN(recommended - selected by default)-
Alternative:
Basic authenticationis also supported
-
-
Create New Token: Click the "+" button in the Tokens section
-
Configure Token (optional customization):
-
Name: Change from "default" if desired (e.g. "API_Access")
-
Expires: Modify expiration date if needed (format: 2026-09-24T19:25:46Z)
-
-
Copy Token: Copy the complete token string from the Token column
-
Click “Save” to finalize configuration
Token Information:
-
Name: System-generated "default" or your custom name
-
Token: Long alphanumeric string for API authentication
-
Expires: Token expiration date
Result: Generated access token appears in tokens table with expiration date and is ready for HTTP client authentication.
Step 4: Configure and Download Postman Collection
Download the Collection: WHINT Integration Cockpit API v1.2.0.json
Import Collection: Open Postman → Import → Upload the downloaded JSON file
Set Variables: Collection → Variables tab:
-
{{WHINT_BASE_URL}}= Your domain from Step 2
(e.g.your-instance.cfapps.eu10.hana.ondemand.com)-
Domain only - no
https://or/api
-
-
{{BEARER_TOKEN}}= Your access token from Step 3
Test Connection: Run "01 - Get All Inventory Items" to verify setup
Expected Result: Successful response with your integration data proves API is ready for production use.
Next: Explore Postman Collection to understand the complete collection structure, then master Essential Operations for core API patterns.
Postman Collection
Professional API collection with 27 organized requests for immediate productivity.
Version Information
Current Version: 1.2.0
Release Date: November 11, 2026
Collection File: WHINT Integration Cockpit API v1.2.0.json
Download: Get Collection WHINT Integration Cockpit API v1.2.0.json
Note: We recommend using the newest Postman Version (12.34.0)
Version: 1.1.1
Release Date: October 30, 2025
Collection File: WHINT Integration Cockpit API v1.1.1.json
Download: Get Collection WHINT Integration Cockpit API v1.1.1.json
Note: We recommend using the newest Postman Version (11.65.0)
Version: 1.1.0
Release Date: September 29, 2025
Collection File: whint_api_collection_v1.1.json
Download: Get Collection whint_api_collection_v1.1.json
Note: We recommend to use the newest Postman Version (11.65.0)
Collection Overview
The collection follows a logical 3-tier progression designed for systematic API mastery:
Variables
Required Variables (Configure Once):
-
{{WHINT_BASE_URL}}- Your instance domain (no https:// or /api) -
{{BEARER_TOKEN}}- Your access token from Integration Cockpit
Optional Variables (Set When Needed):
-
{{EXAMPLE_ID}}- From Create response or Query result (for Update/Metadata operations) -
{{DATA_SOURCE_ID}}- From "Get All Data Sources" request (for "Get Inventory by Data Source") -
{{TAG_ID}}- From "Get Tag Values" response (use 'id' field, not 'tag_id') -
{{PROPERTY_ID}}- From "Get Property Types" response (use 'id' field)
API Reference
Before exploring operations, understand the core API patterns and query structure that power all requests.
Query Structure & Components
JSON Query Components
Core query elements with SQL equivalents for integration architects:
|
JSON Field |
Purpose |
Example |
SQL Equivalent |
|---|---|---|---|
|
|
Specifies which data type to query |
|
|
|
|
Lists specific columns to return |
|
|
|
|
Defines filter conditions |
|
|
|
|
Joins related data from other entities |
|
|
|
|
Restricts number of results returned |
|
|
|
|
Skips specified number of results |
|
|
where filters, with returns. A condition on a related entity in where (for example tags or properties) only decides which records are returned. The related data appears in the response only when the entity is also listed in with.
Response Fields
Standard fields returned in query responses:
|
Response Field |
Description |
Example Value |
|---|---|---|
|
|
Unique identifier for each integration object |
|
|
|
Integration type code (see Integration Types Reference) |
|
|
|
Human-readable integration name |
|
|
|
Object creation timestamp |
|
|
|
Last modification timestamp |
|
Filter Operators
Available operators for WHERE conditions:
|
Operator |
Description |
Example Usage |
|---|---|---|
|
|
Equals exact value |
|
|
|
Contains text (case-sensitive) |
|
|
|
Contains text, ignores upper and lower case |
|
|
|
Matches any value in the list |
|
|
|
Greater than (datetime) |
|
|
|
Less than (datetime) |
|
|
|
Negation operator |
Combined with other operators for exclusion |
Logic Operations
Control how multiple conditions are evaluated:
-
"option": 0- AND logic (all conditions must be true) -
"option": 1- OR logic (any condition can be true)
Apply this knowledge: See Essential Operations for practical examples using these query components.
Entity Reference
Complete reference of available entities for building queries and understanding data relationships.
Core Entities
-
inventory- Integration objects and flows -
dataFlow- End-to-end integration processes -
system- Connected systems -
dataSource- Data source configurations -
metadata- Entity metadata -
property- Property values of inventory items, End-to-End integrations and systems -
tagValue- Tag values (classifications) -
propertyType- Property type definitions
Traffic Entities (Time-based)
|
Entity |
Time Field |
Purpose |
|---|---|---|
|
|
|
BTP CI message traffic |
|
|
|
SAP IDoc traffic |
|
|
|
Logic App executions |
Platform-Specific Entities
-
abapIntegrationEngineInterface- SAP ABAP interfaces -
azureApiManagementApi- Azure APIM APIs -
btpCloudIntegrationArtefact- BTP CI artifacts -
anypointAsset- MuleSoft assets -
solaceQueue- Solace queues
Entity Naming Convention
Convert database names to API format:
-
data_flow→dataFlow -
btp_cloud_integration_message→btpCloudIntegrationMessage
Rule: Change _a-z to A-z
Apply this knowledge: Use correct entity names in your queries as shown in Essential Operations.
Integration Types Reference
Quick reference for accurate platform categorization and filtering in your queries.
Most Common Types
-
Type 24 - SAP IS Cloud Integration
-
Type 25 - SAP Process Orchestration
-
Type 3 - Azure API Management
-
Type 23 - SAP IS API Management
-
Type 0 - MuleSoft API
Type codes depend on the release.
When a new integration type is added, the codes of the types listed after it increase by one.
Usage in Your Queries
Single Platform Analysis:
{
"field": {
"name": "type",
"eq": "23"
}
}
Multi-Platform Analysis: Use OR logic with multiple conditions (Collection: "Get Multiple Integration Types")
Apply this knowledge: Return to Essential Operations for filtering examples or Advanced Operations for multi-platform analysis patterns.
Essential Operations
Master these core operations to understand API fundamentals before advancing to complex scenarios.
Query Operations
Get All Inventory Items
Collection: "01 - Get All Inventory Items"
{
"query": {
"entity": "inventory"
}
}
Retrieves all integration inventory with complete field structure, helping you understand your data model and available fields for subsequent operations.
Use Cases: Initial discovery, landscape assessment, complete integration catalog export
Get Specific Inventory Fields
Collection: "02 - Get Essential Inventory Fields"
{
"query": {
"entity": "inventory",
"fields": ["id", "type", "name", "sender_name", "receiver_name", "description"]
}
}
Use field selection for reporting, dashboards and performance-critical queries where you don't need complete object data.
Use Cases: Dashboard reporting, business stakeholder communication, high-volume queries
Get Inventory by Type (Filtered)
Collection: "03 - Get Integration Types Reference"
{
"query": {
"entity": "inventory",
"where": [{
"option": 0,
"conditions": [{
"field": {
"name": "type",
"eq": "23"
}
}]
}]
}
}
Common Type Codes: 23 (SAP IS API Management), 24 (SAP IS Cloud Integration), 25 (SAP Process Orchestration), 19 (SAP Event Mesh)
Use Cases: Technology-specific analysis, platform migration planning, integration type discovery
See Integration Types Reference for all integration types.
Get Inventory with Data Source (JOIN)
Collection: "04 - Get Inventory Items with Data Source Join"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"with": [{
"entity": "dataSource",
"fields": ["id", "name"]
}]
}
}
This JOIN operation enables traceability analysis, showing which discovery mechanisms contributed specific integrations to your landscape.
Use Cases: Discovery audit trails, data source impact analysis, governance reporting
Mutation Operations
Create Inventory Item
Collection: "01 - Create Inventory Item"
{
"upsert": {
"inventory": [{
"name": "Customer Data Synchronization",
"description": "Bidirectional customer data sync between CRM and ERP systems",
"type": 23
}]
}
}
Supported Fields:
-
name(required): Integration display name -
type(required): Integration type code. It cannot be changed later. -
description(optional): Business purpose description -
sender_id,receiver_id(optional): System IDs from "Get Systems Inventory" -
sender_name,receiver_name(optional): Text only. They do not link a system, usesender_idandreceiver_idfor that. -
data_source_id(optional): ID of your API data source. The item then shows in the Integration Cockpit under this data source, so it is clear that it was created via the API.
Advanced creation can include tags, properties, and metadata in the same upsert operation.
See Advanced Operations for examples.
Response Format: Returns array with new object ID: ["eoF-BJHppnA"]
Copy this ID to {{EXAMPLE_ID}} variable for update operations.
Update Inventory Item
Collection: "02 - Update Inventory Item"
Prerequisites: Set {{EXAMPLE_ID}} variable from Create response or Query result.
{
"upsert": {
"inventory": [{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization - Enhanced",
"description": "Enhanced with error handling and monitoring",
"type": 23
}]
}
}
Updatable Fields: name (required), description, sender_id, receiver_id, tags
Not updatable: type and data_source_id stay as created. A different type is ignored.
An update replaces sender, receiver, tags and objects with what you send.
Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
To keep the current values, query the item first:
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "sender_id", "receiver_id"],
"where": [{
"option": 0,
"conditions": [{"field": {"name": "id", "eq": "{{EXAMPLE_ID}}"}}]
}],
"with": [{"entity": "tags", "fields": ["id"]}]
}
}
Use Cases: Integration lifecycle management, documentation updates
Add Metadata
Collection: "03 - Add Metadata (Additive)"
Prerequisites: Set {{EXAMPLE_ID}} variable from Create response or Query result.
{
"upsert": {
"inventory": [{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization - Enhanced",
"type": 23,
"metadata": [
{"name": "BUSINESS_OWNER", "value": "Customer Operations Team"},
{"name": "TECHNICAL_CONTACT", "value": "integration@company.com"},
{"name": "ENVIRONMENT", "value": "PRODUCTION"}
]
}]
}
}
Metadata Behavior:
-
Additive: Entries without
idare added to the existing metadata -
Updates: To change a value, send the entry with its
id(query it with"with": [{"entity": "metadata", "fields": ["id", "name", "value"]}]) -
No individual deletion: Single metadata entries cannot be removed via the API
Use Cases: Governance tagging, contact information, environment marking, compliance data
An update replaces sender, receiver, tags and objects with what you send.
Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
Advanced Operations
Complex operations for enterprise integration management and governance.
Enterprise Classification
Classification enables systematic categorization using existing taxonomy. You cannot create new tags or property types via API - they must be pre-configured in Integration Cockpit.
Get Available Tag Values
Collection: "Get Tag Values"
{
"query": {
"entity": "tagValue"
}
}
Response Structure:
[
{
"id": "IOWcT-he8Fc",
"create_time": "2025-09-22T07:34:52Z",
"change_time": "2025-09-22T07:34:52Z",
"value": "decommissioned",
"tag_id": "fuWVakMLfHc"
}
]
An update replaces sender, receiver, tags and objects with what you send. Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
Important: Copy the "id" value ("IOWcT-he8Fc"), not the "tag_id" value, to your {{TAG_ID}} variable.
Add Tags to Inventory Item
Collection: "Add Tags to Inventory Item"
Prerequisites:
-
Set
{{EXAMPLE_ID}}from Create response or Query result -
Set
{{TAG_ID}}from Get Tag Values response (idfield)
{
"upsert": {
"inventory": [{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization - Tagged",
"description": "Integration with classification tags",
"tags": [{"id": "{{TAG_ID}}"}]
}]
}
}
Use Cases: Classification, categorization, filtering enhancement
Important: The tags list replaces all current tags of the item.
Include every tag it should keep.
Get Available Property Types
Collection: "Get Property Types"
{
"query": {
"entity": "propertyType"
}
}
Response Structure:
[
{
"id": "a4qYpkuz9UU",
"create_time": "2024-06-04T13:16:25Z",
"change_time": "2025-09-19T09:32:03Z",
"kind": 1,
"format": 2,
"name": "Integration Team"
}
]
Copy the "id" value ("a4qYpkuz9UU") to your {{PROPERTY_ID}} variable.
Add Properties to Inventory Item
Collection: "Add Properties to Inventory Item"
Prerequisites:
-
Set
{{EXAMPLE_ID}}from Create response or Query result -
Set
{{PROPERTY_ID}}from Get Property Types response (idfield)
{
"upsert": {
"inventory": [{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization - With Properties",
"description": "Integration with typed properties",
"properties": [{
"type_id": "{{PROPERTY_ID}}",
"value": "CRITICAL_PRIORITY"
}]
}]
}
}
Important: Each property without id is added as a new entry, so sending the same property twice creates two entries. To change a value, send the property with its id and type_id.
An update replaces sender, receiver, tags and objects with what you send. Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
Use Cases: Configuration parameters, business rules, technical specifications
Advanced Query Patterns
Multi-Platform Analysis (OR Logic)
Collection: "Get Multiple Integration Types"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type", "description"],
"where": [{
"option": 1,
"conditions": [
{"field": {"name": "type", "eq": "23"}},
{"field": {"name": "type", "eq": "24"}},
{"field": {"name": "type", "eq": "25"}},
{"field": {"name": "type", "eq": "19"}}
]
}]
}
}
Logic: "option": 1 creates OR logic - any condition can match.
SAP Technologies: 23 (IS API Management), 24 (IS Cloud Integration), 25 (Process Orchestration), 19 (Event Mesh)
Use Cases: Platform family analysis, migration planning, technology consolidation assessment
Complete SAP Ecosystem Query
Collection: "Get Complete SAP Integration Landscape"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type", "sender_name", "receiver_name"],
"where": [{
"option": 1,
"conditions": [
{"field": {"name": "type", "eq": "16"}},
{"field": {"name": "type", "eq": "17"}},
{"field": {"name": "type", "eq": "18"}},
{"field": {"name": "type", "eq": "19"}},
{"field": {"name": "type", "eq": "20"}},
{"field": {"name": "type", "eq": "21"}},
{"field": {"name": "type", "eq": "22"}},
{"field": {"name": "type", "eq": "23"}},
{"field": {"name": "type", "eq": "24"}},
{"field": {"name": "type", "eq": "25"}},
{"field": {"name": "type", "eq": "26"}},
{"field": {"name": "type", "eq": "27"}},
{"field": {"name": "type", "eq": "28"}},
{"field": {"name": "type", "eq": "29"}},
{"field": {"name": "type", "eq": "33"}},
{"field": {"name": "type", "eq": "34"}},
{"field": {"name": "type", "eq": "35"}}
]
}]
}
}
SAP Platform Types: 16 (Planned Integration), 17 (OData), 18 (SOAP), 19 (Event Mesh), 20 (IDoc), 21 (XI), 22 (File), 23 (IS API Management), 24 (IS Cloud Integration), 25 (Process Orchestration), 26 (EAM), 27 (Solace Queues), 28 (RFC), 29 (PO CI), 33 (ASAPIO), 34 (ICF), 35 (Communication Arrangements)
Use Cases: Complete SAP integration inventory, enterprise architecture documentation, migration planning
Search by Name Pattern (Text Search)
Collection: "Search Integrations by Name Pattern"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "sender_name", "receiver_name", "type"],
"where": [{
"option": 1,
"conditions": [{
"field": {
"name": "name",
"ilike": "Customer"
}
}]
}]
}
}
Customization: Replace "Customer" with any search term to find integrations by business domain.
ilike ignores upper and lower case, like is case-sensitive.
Use Cases: Content discovery, business domain filtering, integration name searches
Get Inventory by Data Source
Collection: "Get Inventory by Data Source"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"where": [{
"option": 0,
"conditions": [{"field": {"name": "data_source_id", "eq": "{{DATA_SOURCE_ID}}"}}]
}],
"with": [{"entity": "dataSource", "fields": ["name"]}],
"limit": 1000
}
}
Returns all inventory items discovered by one data source. Get the ID from "Get All Data Sources".
To filter by data source name instead, replace the condition with {"entity": {"name": "dataSource", "predicates": [{"conditions": [{"field": {"name": "name", "eq": "Your Data Source"}}]}]}}.
Use Cases: Inventory of one tenant, checking a data source run, comparing environments
Get Inventory by System (Sender or Receiver)
Collection: "Get Inventory by System (Sender or Receiver)"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"where": [{
"option": 1,
"conditions": [
{
"entity": {
"name": "sender",
"predicates": [{
"conditions": [{"field": {"name": "name", "eq": "SAP S/4HANA"}}]
}]
}
},
{
"entity": {
"name": "receiver",
"predicates": [{
"conditions": [{"field": {"name": "name", "eq": "SAP S/4HANA"}}]
}]
}
}
]
}],
"with": [
{"entity": "sender", "fields": ["name"]},
{"entity": "receiver", "fields": ["name"]}
],
"limit": 1000
}
}
Returns every inventory item that has the system as sender or receiver ("option": 1 = OR).
Customization: Replace "SAP S/4HANA" with your system name.
System names can exist once per data source. The name filter returns the inventory items of all systems with this name. For exactly one system, filter on sender_id and receiver_id with the system ID.
Use Cases: Impact analysis before a system migration, system documentation, interface lists for system owners
Get Inventory by Tag
Collection: "Get Inventory by Tag"
Prerequisites: Set {{TAG_ID}} from "Get Tag Values" (use the id field, not tag_id)
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"where": [{
"option": 0,
"conditions": [{
"entity": {
"name": "tags",
"predicates": [{
"conditions": [{"field": {"name": "id", "in": {"value": ["{{TAG_ID}}"]}}}]
}]
}
}]
}],
"with": [{
"entity": "tags",
"fields": ["value", "tag_id"],
"with": [{"entity": "tag", "fields": ["name"]}]
}],
"limit": 1000
}
}
Returns all inventory items with the tag. Add "not": true next to "entity" to get all inventory items without the tag. Add more IDs to the "value" list to match any of several tags.
Use Cases: Decommissioning and migration lists, classification reports, governance reviews
Get Inventory by Property Value
Collection: "Get Inventory by Property Value"
Prerequisites: Set {{PROPERTY_ID}} from "Get Property Types" (id field)
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"where": [{
"option": 0,
"conditions": [{
"entity": {
"name": "properties",
"predicates": [{
"conditions": [
{"field": {"name": "type_id", "eq": "{{PROPERTY_ID}}"}},
{"field": {"name": "value", "eq": "Yes"}}
]
}]
}
}]
}],
"with": [{
"entity": "properties",
"fields": ["type_id", "value"],
"with": [{"entity": "type", "fields": ["name"]}]
}],
"limit": 1000
}
}
Returns all inventory items with a property of this type and this value. Both conditions are in the same predicate, so they must match on the same property.
Customization: Replace "Yes" with the value you are looking for. For value-list properties, use the text of the list entry.
Renamed value-list entries: value keeps the text that was selected. If the list entry was renamed later, filter on the list entry instead: {"entity": {"name": "valueList", "predicates": [{"conditions": [{"field": {"name": "name", "eq": "Yes"}}]}]}}
Use Cases: Inventory items per team, owner or business domain, audit and review lists
Traffic Monitoring & Analysis
Monitor Integration Performance
Collection: "Monitor BTP Integration Performance"
{
"query": {
"entity": "btpCloudIntegrationMessage",
"fields": ["sender", "artefact", "package", "duration", "status", "started_on"],
"where": [{
"conditions": [{
"field": {
"name": "started_on",
"gt_time": "2025-09-01T00:00:00.000Z"
}
}]
}],
"limit": 200
}
}
Time Filter: gt_time retrieves messages processed after the specified timestamp.
Customization: Adjust date in "gt_time" and "limit" value as needed.
Use Cases: SLA compliance monitoring, performance bottleneck identification, operational dashboards
Monitor Performance (Time Window)
Collection: "Monitor BTP Integration Performance - Time Window"
{
"query": {
"entity": "btpCloudIntegrationMessage",
"fields": ["sender", "artefact", "package", "duration", "status", "started_on"],
"where": [{
"conditions": [
{
"field": {
"name": "started_on",
"gt_time": "2025-08-31T23:59:59.999Z"
}
},
{
"field": {
"name": "started_on",
"lt_time": "2025-09-01T00:01:00.001Z"
}
}
]
}],
"limit": 200
}
}
Time Window: Combines gt_time (after) and lt_time (before) for precise time range filtering.
Customization: Adjust "limit" value as needed.
Use Cases: Incident analysis, batch processing verification, maintenance window troubleshooting
Process Architecture Mapping
End-to-End Flow Mapping (Complex JOINs)
Collection: "End-to-End Integration Flow Mapping"
{
"query": {
"entity": "dataFlow",
"with": [
{
"entity": "sender",
"fields": ["name"],
"with": [
{
"entity": "dataSource",
"fields": ["name"]
}
]
},
{
"entity": "receiver",
"fields": ["name"],
"with": [
{
"entity": "dataSource",
"fields": ["name"]
}
]
},
{
"entity": "items",
"fields": ["seq"],
"with": [
{
"entity": "inventory",
"fields": ["name", "type"],
"with": [
{
"entity": "dataSource",
"fields": ["name"]
}
]
}
]
}
],
"order": [{"field": "id"}],
"limit": 100
}
}
JOIN Pattern: seq is the position of the interface within the End-to-End integration. For the next page, increase "offset" by 100.
Use Cases: End-to-end process documentation, integration architecture visualization, business process impact analysis, data lineage
Impact Analysis by Interface
Collection: "Impact Analysis - End-to-End Integrations Using an Interface"
Prerequisites: Set {{EXAMPLE_ID}} to the ID of an inventory item (from any inventory query)
{
"query": {
"entity": "dataFlow",
"fields": ["id", "name"],
"where": [{
"option": 0,
"conditions": [{
"entity": {
"name": "items",
"predicates": [{
"conditions": [{"field": {"name": "inventory_id", "eq": "{{EXAMPLE_ID}}"}}]
}]
}
}]
}],
"with": [{
"entity": "items",
"fields": ["seq", "inventory_id"],
"with": [{"entity": "inventory", "fields": ["name", "type"]}]
}]
}
}
Returns every End-to-End integration that contains the inventory item, with its complete chain of interfaces.
Use Cases: Change impact before modifying or decommissioning an interface, business process impact analysis, incident analysis
Working with the API
Performance Optimization
Use Field Selection
Collection: "02 - Get Essential Inventory Fields" - Customized
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"limit": 1000
}
}
Note: This example adds
"limit": 1000for production best practices.
The Postman collection example omits limit for simplicity.
Strategic field selection reduces response times and network overhead by requesting only needed data.
Customization: Adjust "limit" value as needed.
Use Cases: High-volume queries, dashboard refresh operations, API performance optimization
Implement Pagination
Collection: Multiple collection requests
// Pagination completion logic
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type"],
"order": [{"field": "id"}],
"limit": 100,
"offset": 0
}
}
// Continue until response.length < limit (e.g. < 100)
Pagination Process: Start with offset 0 and limit 100, process results, then increment offset by 100 for next batch (offset: 100, 200, 300...). Continue until response contains fewer than 100 results, indicating completion.
Always use order when paging. Without it, the database does not guarantee the same row order between calls, so pages can overlap or skip rows.
Customization: Adjust "limit" value as needed.
Use Cases: Large dataset processing, bulk exports, batch operations
Condition Based Queries
Collection: "03 - Get Integration Types Reference"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type", "description"],
"where": [{
"conditions": [{
"field": {
"name": "type",
"eq": "23"
}
}]
}],
"limit": 200
}
}
Note: This example adds
"limit": 200for production best practices.
The Postman collection example omits limit for simplicity.
Performance Rules:
-
Always use
fieldsarray to minimize data transfer -
Apply
whereconditions early to reduce dataset size -
Always include
limitfor large entity queries to prevent instance overload and timeouts -
Use
withjoins only for required data
Use Cases: Production deployments, high-performance requirements, enterprise-scale operations
Timebased Condition Queries
Collection: Query operations with time filters
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "change_time"],
"where": [{
"conditions": [{
"field": {
"name": "change_time",
"gt_time": "2025-01-15T14:30:00.000Z"
}
}]
}]
}
}
Incremental change detection enables efficient monitoring of integration landscape updates.
Use Cases: Daily change reports, governance compliance, automated landscape monitoring
Bulk Operations
Create Multiple Items
{
"upsert": {
"inventory": [
{
"name": "Integration A",
"type": 24,
"description": "SAP Integration Suite flow"
},
{
"name": "Integration B",
"type": 25,
"description": "SAP Process Orchestration interface"
}
]
}
}
Efficient bulk creation processes multiple inventory items in single requests for better performance.
Response Format: Returns array of created IDs in same order as input, enabling subsequent operations on bulk-created items.
Use Cases: Migration projects, initial landscape setup, batch provisioning
Metadata and Classification Operations
Add Metadata (Additive Only)
Collection: "03 - Add Metadata (Additive)"
{
"upsert": {
"inventory": [
{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization",
"type": 23,
"description": "Bidirectional customer data sync",
"metadata": [
{"name": "BUSINESS_OWNER", "value": "Customer Operations Team"},
{"name": "TECHNICAL_CONTACT", "value": "integration@company.com"},
{"name": "ENVIRONMENT", "value": "PRODUCTION"}
]
}
]
}
}
Critical Requirements:
-
Required field:
name.typeis only needed when creating an item and is ignored on updates. -
Optional Fields:
descriptionis optional but recommended for maintaining data completeness -
Additive: Entries without
idare added to the existing metadata -
Updates: To change a value, send the entry with its
id -
No individual deletion: Single metadata entries cannot be removed via the API
An update replaces sender, receiver, tags and objects with what you send. Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
Use Cases: Governance tagging, contact information, environment marking, compliance data
Add Tags to Inventory Items
Collection: "Add Tags to Inventory Item"
Prerequisites: Run "Get Tag Values" to discover available tag IDs
{
"upsert": {
"inventory": [
{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization - Tagged",
"description": "Integration with classification tags",
"tags": [
{
"id": "{{TAG_ID}}"
}
]
}
]
}
}
Important ID Selection:
-
Use the
idfield from tag records (primary key) -
NOT the
tag_idfield (category reference) -
Tags must be pre-configured in Integration Cockpit UI - cannot create new tag values via API
-
The
tagslist replaces all current tags of the item. Include every tag it should keep.
Setup Process:
-
Run "Get Tag Values" query
-
Find desired tag (e.g., value: "decommissioned")
-
Copy its
idfield value (e.g., "IOWcT-he8Fc") -
Set
{{TAG_ID}}variable with this value -
Execute tag assignment request
An update replaces sender, receiver, tags and objects with what you send. Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
Use Cases: Classification, categorization, filtering enhancement
Add Properties to Inventory Items
Collection: "Add Properties to Inventory Item"
Prerequisites: Run "Get Property Types" to discover available property type IDs
{
"upsert": {
"inventory": [
{
"id": "{{EXAMPLE_ID}}",
"name": "Customer Data Synchronization - With Properties",
"description": "Integration with typed properties",
"properties": [
{
"type_id": "{{PROPERTY_ID}}",
"value": "CRITICAL_PRIORITY"
}
]
}
]
}
}
Important ID Selection:
-
Use the
idfield from property type records (primary key) -
Property types must be pre-configured in Integration Cockpit UI - cannot create new property types via API
-
Values must conform to property type validation rules
-
Each property without
idis added as a new entry, so sending the same property twice creates two entries -
To change a value, send the property with its
idandtype_id
Setup Process:
-
Run "Get Property Types" query
-
Find desired property type (e.g., name: "Priority Level")
-
Copy its
idfield value (e.g., "V3G9lX8iEO4") -
Set
{{PROPERTY_ID}}variable with this value -
Execute property assignment request
An update replaces sender, receiver, tags and objects with what you send. Send sender_id, receiver_id and the complete tags list along, otherwise they are removed. Description, metadata and properties are kept.
Use Cases: Configuration parameters, business rules, technical specifications
Time-Based Query Patterns
Time-Based Filtering
Collection: "Monitor BTP Integration Performance - Time Window"
{
"query": {
"entity": "btpCloudIntegrationMessage",
"fields": ["sender", "artefact", "duration", "status", "started_on"],
"where": [{
"conditions": [
{
"field": {
"name": "started_on",
"gt_time": "2025-08-31T23:59:59.999Z"
}
},
{
"field": {
"name": "started_on",
"lt_time": "2025-09-01T00:01:00.001Z"
}
}
]
}],
"limit": 200
}
}
Time Operators:
-
gt_time: Greater than (after) specified timestamp -
lt_time: Less than (before) specified timestamp -
Combine for precise time windows
Customization: Adjust "limit" value as needed.
Use Cases: Incident analysis, batch verification, compliance reporting for exact time ranges
Multi-Type Filtering
Collection: "Get Multiple Integration Types"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type", "description"],
"where": [{
"option": 1,
"conditions": [
{"field": {"name": "type", "eq": "23"}},
{"field": {"name": "type", "eq": "24"}},
{"field": {"name": "type", "eq": "25"}},
{"field": {"name": "type", "eq": "19"}}
]
}]
}
}
Logic Options:
-
option: 0= AND logic (all conditions must match) -
option: 1= OR logic (any condition can match)
Use Cases: Platform family analysis, migration planning, technology consolidation assessment
Complete Export
Systematic export strategy for backup, migration or governance reporting.
Export Interfaces
{
"query": {
"entity": "inventory",
"fields": ["name", "type", "description"],
"with": [
{
"entity": "sender",
"fields": ["name"],
"with": [
{ "entity": "properties",
"fields": ["type_id","value"],
"with": [{
"entity": "type",
"fields": ["name", "kind"]
}]
}
]
},
{
"entity": "receiver",
"fields": ["name"],
"with": [
{ "entity": "properties",
"fields": ["type_id","value"],
"with": [{
"entity": "type",
"fields": ["name", "kind"]
}]
}
]
},
{"entity": "tags",
"fields": ["value","tag_id"],
"with": [{
"entity": "tag",
"fields": ["name"]
}]
},
{
"entity": "metadata",
"fields": ["name", "value"]
},
{ "entity": "properties",
"fields": ["type_id","value"],
"with": [{
"entity": "type",
"fields": ["name", "kind"]
}]
}
],
"order": [{"field": "id"}],
"limit": 5000,
"offset": 0
}
}
Retrieves all inventory interfaces with comprehensive metadata including senders, receivers, properties, tags and metadata.
For the next page, continue with "offset": 5000, 10000, … until fewer rows than the limit are returned. "order" keeps the row order identical between pages.
Use Cases: Complete inventory backup, environment migration,
governance reporting, compliance documentation
Export End-to-End Integrations
Collection: "End-to-End Integration Flow Mapping"
{
"query": {
"entity": "dataFlow",
"with": [
{
"entity": "sender",
"fields": ["name"],
"with": [
{
"entity": "dataSource",
"fields": ["name"]
}
]
},
{
"entity": "receiver",
"fields": ["name"],
"with": [
{
"entity": "dataSource",
"fields": ["name"]
}
]
},
{
"entity": "items",
"fields": ["seq"],
"with": [
{
"entity": "inventory",
"fields": ["name", "type"],
"with": [
{
"entity": "dataSource",
"fields": ["name"]
}
]
}
]
}
],
"order": [{"field": "id"}],
"limit": 100
}
}
Exports complete end-to-end process flows with relationships.
Use Cases: Process documentation, data lineage, impact analysis
Export End-to-End Integrations with Tags and Properties
Collection: "End-to-End Integrations with Tags & Properties"
{
"query": {
"entity": "dataFlow",
"fields": ["id", "name", "description"],
"with": [
{
"entity": "tags",
"fields": ["value", "tag_id"],
"with": [{"entity": "tag", "fields": ["name"]}]
},
{
"entity": "properties",
"fields": ["type_id", "value", "value_list_id"],
"with": [
{"entity": "type", "fields": ["name"]},
{"entity": "valueList", "fields": ["name"]}
]
}
],
"order": [{"field": "id"}],
"limit": 100,
"offset": 0
}
}
Returns End-to-End integrations with their tags (value and tag name) and properties (value and property type name).
Renamed value-list entries: value keeps the text that was selected. If the list entry was renamed later, filter on the list entry instead: {"entity": {"name": "valueList", "predicates": [{"conditions": [{"field": {"name": "name", "eq": "Yes"}}]}]}}
To filter, add a "where" next to "with". Example – End-to-End integrations without a given tag and with a given value-list property value:
"where": [{
"conditions": [
{"not": true, "entity": {"name": "tags", "predicates": [
{"conditions": [{"field": {"name": "id", "in": {"value": ["{{TAG_ID}}"]}}}]}]}},
{"entity": {"name": "properties", "predicates": [
{"conditions": [
{"field": {"name": "type_id", "eq": "{{PROPERTY_ID}}"}},
{"entity": {"name": "valueList", "predicates": [
{"conditions": [{"field": {"name": "name", "eq": "Yes"}}]}]}}
]}]}}
]
}]
"with" returns all tags and properties of each End-to-End integration, not only the ones used in the filter. To return a single property type, add "where": [{"conditions": [{"field": {"name": "type_id", "eq": "{{PROPERTY_ID}}"}}]}] inside the "properties" block.
Use Cases: Classification export, governance reporting, impact analysis by tag or property
Export Systems
Collection: "06 - Get Systems Inventory"
{
"query": {
"entity": "system"
}
}
Exports all connected systems in the integration architecture.
Use Cases: Architecture documentation, system landscape backup, migration planning
Export Metadata
Standalone Export
{
"query": {
"entity": "metadata"
}
}
Retrieves all metadata entries across the entire system without inventory context.
Use Cases: Metadata-only backup, governance tag analysis, metadata schema documentation
Metadata export with Inventory Context (Recommended)
Collection: "Get Inventory with Metadata Context"
{
"query": {
"entity": "inventory",
"fields": ["id", "name", "type", "description"],
"with": [
{
"entity": "metadata",
"fields": ["name", "value"]
}
]
}
}
Retrieves inventory items with their associated metadata, showing which integrations have which governance tags.
Use Cases: Governance reporting, compliance documentation, understanding metadata distribution across integrations
Export Properties
Collection: “Get Property Types”
{
"query": {
"entity": "propertyType"
}
}
Exports all property types (the definitions, not the values). For the property values of inventory items, use "Export Interfaces" or query the property entity.
Use Cases: Configuration backup, cross-tenant migration, disaster recovery
Export Tags
Collection: “Get Tag Values”
{
"query": {
"entity": "tagValue"
}
}
Retrieves complete classification taxonomy structure.
Use Cases: Taxonomy backup, classification migration, governance documentation
Troubleshooting
Quick solutions for common API issues.
Authentication
|
Problem |
Solution |
|---|---|
|
401 Unauthorized |
Token expired - regenerate in Settings → Data Sources → API |
|
|
Set variable in Collection → Variables (not Environment) |
|
Token format error |
Use |
Connection
|
Problem |
Solution |
|---|---|
|
Cannot reach endpoint |
Verify URL: |
|
Request timeout |
Add |
|
SSL/TLS errors |
Check domain spelling matches your instance exactly |
Query Structure
|
Problem |
Solution |
|
|---|---|---|
|
Entity not found |
Use camelCase: |
|
|
Field not found |
Run query without |
|
|
Empty response |
Not an error - no records match your filters. Remove |
|
|
Invalid JSON |
Check commas, brackets, quotes - use Postman's validator |
|
|
Tags or Properties missing |
A |
|
|
Invalid field "sequence" for query |
Use |
|
|
Type filter returns other interfaces after an upgrade |
Type codes shift when new types are added. Check the Integration Types Reference |
|
|
Sender, receiver or tags missing after an update |
An update replaces them. Send |
|
Common Query Fixes
Wrong entity name:
❌ "entity": "btp_cloud_integration_message"
✅ "entity": "btpCloudIntegrationMessage"
Missing required update fields:
❌ {"id": "abc", "description": "new"}
✅ {"id": "abc", "name": "Integration Name", "description": "new", "sender_id": "...", "receiver_id": "...", "tags": [{"id": "..."}]}
name is required. Send sender_id, receiver_id and tags along, otherwise they are removed.
Wrong filter syntax:
❌ "eq": 23
✅ "eq": "23"
Variables
|
Problem |
Solution |
|---|---|
|
|
Run Create request first, copy returned ID to variable |
|
|
Use |
|
Variables not resolving |
Set in Collection Variables → Save → Close/reopen request tabs |
Performance
|
Issue |
Fix |
|---|---|
|
Slow queries |
Add |
|
Large datasets |
Use |
|
Multiple joins slow |
Only include |
Last Updated: November 12, 2026