SAP IoT API Reference Guide
SAP IoT API Reference Guide
Content
What is SAP IoT
About this API Reference
Application Names in Service URIs
Migrating from REST to OData
Device Connectivity API Reference
Business Partner
Organization
Create an Organization
Read an Organization
Read all Organizations
Read all Matching Organizations
Update an Organization
Delete an Organization
Payload of CapabilityType "Organization"
DeletedOrganization
Read a DeletedOrganization
Read all DeletedOrganizations
Delete a DeletedOrganization
Person
Create a Person
Read a Person
Read all Persons
Read all Matching Persons
Update a Person
Delete a Person
Payload of CapabilityType "Person"
DeletedPerson
Read a DeletedPerson
Read all DeletedPersons
Delete a DeletedPerson
Retrieving Enriched Person Data
BPRelationship
Create a BPRelationship
Read a BPRelationship
Read all BPRelationships
Delete a BPRelationship
DeletedBPRelationship
Read a DeletedBPRelationship
Read all DeletedBPRelationships
Delete a DeletedBPRelationship
BPRole
Create a BPRole
Read a BPRole
Read all BPRoles
Delete a BPRole
DeletedBPRole
Read a DeletedBPRole
Read all DeletedBPRoles
Delete a DeletedBPRole
BPUserRelationship
Create a BPUserRelationship
Read a BPUserRelationship
Read all BPUserRelationships
Read all Matching BPUserRelationships
Delete a BPUserRelationship
DeletedBPUserRelationship
Read a DeletedBPUserRelationship
Read all DeletedBPUserRelationships
Delete a DeletedBPUserRelationship
Geolocation
Managing Geolocation Semantics
Locales
Retrieve the list of Localized descriptions
Geometry Types
Retrieve the list of Geometry types
Geolocation Spaces
Create a Space
Retrieve the list of Spaces
Retrieve a Space
Update a Space
Delete a Space
Managing Geolocations
Create a Geolocation
Retrieve the List of Geolocations
Retrieve a Geolocation
Update a Geolocation (PUT)
Update a Geolocation (PATCH)
Delete a Geolocation
Match Geolocations
Match Geolocations within a Geolocation
Match Geolocations within a Geoposition
Search Geolocations in close vicinity to another Geolocation
Search Geolocations within a specified distance from a Geoposition
Space Hierarchies and Location Hierarchies
Retrieve the List of Hierarchies of Spaces
Retrieve a Hierarchy of Spaces
Retrieve the list of Hierarchies for the Locations of a Space
Retrieve a Hierarchy for the Locations of a Space
Authorization
Role Template and Scopes
Error Response Structures
Thing Clustering
Geo-semantics Configuration
Create Geo-semantic Configuration
Read Geo-semantics Configuration
Update Geo-semantic Configuration
Delete all Geo-semantics Configurations
Delete a Geo-semantics Configuration
Thing Clustering API
Authorization
Object Instance-Based Authorization
ObjectGroup
Create an ObjectGroup
Read an ObjectGroup
Read all ObjectGroups
Update an ObjectGroup
Delete an ObjectGroup
Root Object Group of a Tenant
Read the Root ObjectGroup
CapabilityType
Read a CapabilityType
Read all CapabilityTypes
Capability
Create a Capability
Read a Capability
Read all Capabilities
Update a Capability
Delete a Capability
Filter Terms
ObjectGroupCollection
Create an ObjectGroupCollection
Read an ObjectGroupCollection
Read all ObjectGroupCollections
Delete an ObjectGroupCollection
ObjectGroupCollectionItem
Create an ObjectGroupCollectionItem
Read an ObjectGroupCollectionItem
Read all ObjectGroupCollectionItems
Update an ObjectGroupCollectionItem
Delete an ObjectGroupCollectionItem
Capabilities
Functional Authorization
Accessing SAP IoT APIs Using OAuth Token
Role Templates and Scopes
Onboarding Services
Tenant
Read a Tenant
Read All Tenants
Onboarding Organizations
Create Organization Assignment
Read Organization Assignment
Delete Organization Assignment
Onboarding Persons
Create Person Assignment
Read Person Assignment
Update Person Assignment
Delete Person Assignment
UserGroup
Create a UserGroup
Read a UserGroup
Read all UserGroups
Update a UserGroup
Delete a UserGroup
IdentityZone
Create an IdentityZone
Data Protection and Privacy
Delete User Data
Export Rule Data
Configuration: Metadata Objects
Reference Property Set Type
Configuration: OData Service
Package Configuration
Read Metadata of Package
Create a Package
Read a Package
Read all Packages
Update a Package
Delete a Package
Thing Configuration
Read Metadata of Thing Configuration
Thing Type
Extended Thing Type
Thing Type Category
Create a Thing Type
Read Details of a Thing Type
Read all Thing Types
Read Thing Types of a Package
Update a Thing Type
Delete a Thing Type
Thing Type Association
Create Thing Type Association
Read Association Details of a Thing Type
Delete Thing Type Association
Thing Template
Create a Thing Template
Read all Thing Templates for a Package
Read all Thing Templates
Read all Thing Templates of a Thing Type
Read Details of a Thing Template
Update a Thing Template
Delete a Thing Template
Property Set Type
Create a Property Set Type
Read Details of a Property Set Type
Read all Property Set Types
Read all Property Set Types of a Package
Update a Property Set Type
Delete a Property Set Type
Read all Properties of a Property Set Type
Property Type
Create a Property Type
Read Details of a Property Type
Read all Property Types
Read all Property Types of a Package
Update a Property Type
Delete a Property Type
Annotation
Create Annotation
Read Details of an Annotation
Read all Annotations of a Package
Update an Annotation
Delete an Annotation
Event Configuration
Event Type with Single Event Property Set
Read Metadata of Event Configuration
Create Event Type
Read Details of an Event Type
Read Statuses of an Event Type
Read Severities of an Event Type
Read Codes of an Event Type
Read all Event Types
Read Statuses of all Event Types
Read Severities of all Event Types
Read Codes of all Event Types
Update an Event Type
Delete an Event Type
Event Type with Multiple Event Property Sets
Read Metadata of Event Configuration with Multiple Event Property Set Types
Create Event Type with Multiple Event Property Sets
Read Details of an Event Type
Read Statuses of an Event Type
Read Severities of an Event Type
Read Codes of an Event Type
Read all Event Types
Read Statuses of all Event Types
Read Severities of all Event Types
Read Codes of all Event Types
Update an Event type
Delete an Event type
Event Property Set Type
Create Event Property Set Type
Read Details of an Event Property Set Type
Read all Event Property Set Types
Update an Event Property Set Type
Delete an Event Property Set Type
Thing Type and Sensor Type Mapping
Create a Thing Type and Sensor Type Mapping
Read a Thing Type with its Sensor Type Mappings
Read all Sensor Types associated with a Thing Type
Update Sensor Type Mappings or Sensor Types in the Thing Type
Delete a Thing Type with its Sensor Type Mappings
Custom Master Data
Object Types
Create an Object Type
Update an Object Type
Read an Object Type
Read all Object Types
Read all Object Types of a Package
Delete an Object Type
Standard Object Types
Object Type Association
Create Object Type Association
Read all Object Type Associations
Delete Object Type Association
Object Instances
Metadata of Object Instances
Create an Object Instance
Update an Object Instance
Read an Object Instance
Read all Object Instances
Delete an Object Instance
$Batch
Instance Associations
Create an Instance Association
Read an Instance Association
Read all Instance Associations
Delete an Instance Association
$Batch
Create Instance Association with Standard Object Types
Role Templates and Scopes
Value Data Types for Object Types and Properties
Limitations
Audit Logs
Data Protection and Privacy
Custom Master Data Composite Services
Composite Custom Master Data Basic Service
Read Metadata of Composite Custom Master Data Basic Service
Read List of Things
Composite Custom Master Data Details Service
Read Metadata of Composite Custom Master Data Details Service
Read List of Things
Smart Sensing
Auto-ID
Actions
Create an Action
Update an Action
Read an Action
Read all Actions
Delete an Action
Delete Actions
Create an Action Event
Update an Action Event
Get Pending/all Action Events
Thing
Thing Data
Time Series Data Ingestion
Monitoring Time Series Data Ingestion Delay
Onboarding Things
Create a Thing
Example 1 – Create a thing for a specific thing type
Example 2 – Create a thing with a specific alternate thing ID
Example 3 – Create a thing based on a thing template
Example 4 – Create a thing along with data for properties
Example 5 – Create thing with custom master data association
Create a Thing along with sensor assignment
Create a thing with sensor assignment
Create a thing with sensor assignment using alternate ID
Create Multiple Things
Example 1 – Create multiple things for a thing type
Example 2 – Create multiple things using thing template
Read a Thing by Alternate ID
Read a Thing
Read Thing Configuration Details for a Thing
Update a Thing
Delete a Thing
Read all Things
Payload of CapabilityType "Thing"
Sensors and Things
Flexible Mapping (OData)
Credentials
Create Credentials
Read Credentials
Update Credentials
Delete Credentials
Mapping
Create a Mapping
Read a Mapping
Read all Mapping Master Data
Read all Mapping IDs
Update a Mapping
Update Mapping Master Data
Delete a Mapping
Validate a Mapping
Propose Mappings
Read all Assignments for a Mapping
Delete all Assignments for a Mapping
Assignment
Create an Assignment
Read an Assignment
Read all Assignments
Update an Assignment
Delete an Assignment
Error Messages
Read all Error Messages
Grouping of Things
Thing Group
Read Metadata of Thing Group
Create Thing Group
Read a Thing Group
Read all Thing Groups
Delete Thing Group
Update Thing Group
Thing Group Element
Read Thing Group Elements
Thing Group Description
Association of Things
Read Metadata of Thing Association
Create Thing Association
Read All Associations of a Thing
Read Details of a Thing Association
Delete Association of a Thing
Read Version Information of Thing Service
HTTP Status Codes for Thing Services
Thing: Master Data and Parameters Data
Read Metadata for a Thing
Create Data for a Thing
Create Data Using Alternate Thing ID
Read Data for a Thing
Delete Data for a Thing
Read Property Set Data
Thing: Reference Property Data
Create Data for Reference Properties
Read Data for Reference Properties
Read Reference Properties Data for a List of Property Sets
Delete Data for Reference Properties
Thing: Time Series Data
Time Series Store
Create Time Series Data Store for Tenant
Create Retention Period for Time Series Data Store
Read Retention Period of Time Series Data
Create Time Series Data or Derived Data for a Thing
Create Time Series Data or Derived Data Using Alternate Thing ID
Read Time Series Data or Derived Data for a Thing
Delete Time Series Data or Derived Data
Time Series Aggregate Store
Read Time Series Data for a Property of a Thing Applying M4 Algorithm
Read Time Series Data for Multiple Properties of a Thing Applying M4 Algorithm
Recalculate M4 Aggregates for Time Series Data
Read Snapshot Data of a Thing
Read Snapshot Data Within a Time Range for a Thing
Time Series Cold Store
Create Time Series Data or Derived Data for a Thing
Read Time Series Data or Derived Data for a Thing
Delete Time Series Data or Derived Data
Export Time Series Data
Initiate Time Series Data Export
Read Time Series Data Export Status
Download Time Series Data
Thing Time Series Data: OData Service
Read Metadata
Aggregates
Read Aggregates of Measurements
Measurements
Read Single Measurement
Read Multiple Measurements
Rule Services
Rule Project
Create a Rule Project
Read a Rule Project
Read all Rule Projects
Update a Rule Project
Delete a Rule Project
Read BRM Details
Read Data Object Details
Batch Rule
Create a Batch Rule
Read a Batch Rule
Read all Batch Rules
Update a Batch Rule
Delete a Batch Rule
Activate a Batch Rule
Deactivate a Batch Rule
Read Simulation Data
Simulate a Batch Rule
Read Activation Details
Execute a Batch Rule
Read a Batch Rule Execution
Read all Batch Rule Executions
Streaming Rule
Create a Streaming Rule
Read a Streaming Rule
Read all Streaming Rules
Update a Streaming Rule
Delete a Streaming Rule
Activate a Streaming Rule
Deactivate a Streaming Rule
Read Simulation Data (Streaming Rule)
Simulate a Streaming Rule
Read Activation Details (Streaming Rule)
Derivation Rule
Create a Derivation Rule
Read a Derivation Rule
Rule Data Management and Rules Service
Export Rule Data
Find a Rule
Read all Rules
Segment Service
Segment Service Messaging
Handling of Delayed Events (Latecomers)
Recognition Configuration
Create a Recognition Configuration
Activate Recognition Configurations
Deactivate Recognition Configurations
Read a Recognition Configuration
Read all Recognition Configurations
Update a Recognition Configuration
Delete a Recognition Configuration
Segment
Create a Segment
Read a Segment
Read all Segments
Update a Segment
Delete a Segment
Tag
Read all Tags
Thing Hierarchy
Thing Hierarchy
Thing Hierarchy
Read Metadata of Thing Hierarchy
Create Thing Hierarchy
Read Thing Hierarchy
Read Sub-hierarchy for a Thing
Read all Thing Hierarchies
Delete Thing Hierarchy
Update Thing Hierarchy
Thing Hierarchy Element
Read Thing Hierarchy Elements
Thing Hierarchy Description
Read Version Information of Thing Hierarchy Service
HTTP Status Codes for Thing Hierarchy
Event Services
Standard or Predefined Events (Deprecated)
Create an Event
Read an Event
Read all Events
Update an Event
Update Status for Multiple Events
Delete an Event
Delete all Events
Read Version Information of Event Service
HTTP Status Codes for Event Services
User-defined Events (/v1 version)
Read Metadata for Event of an Event Type
Create and Update Events
Read Events and Event Data
Delete an Event
Read Metadata for Event
Read Events
Read Event Correlations
Read Events with a Correlation ID
Delete an Event Using Correlation ID
Delete Events
User-defined Events (/v2 version)
Read Metadata for Event of an Event Type
Create and Update Events
Read Events and Event Data
Delete an Event
Read Metadata for Event
Read Events
Read Event Correlations
Read Events with a Correlation ID
Delete an Event Using Correlation ID
Delete Events
Migrate Standard or Pre-Defined Events
File
Upload a File
Read a File
Read Metadata
Delete a File
Read Version Information of File Service
HTTP Status Codes for File Services
Composites
Composite Things: REST Service
Read Thing Details with Property Set Type Data
Read Version Information of Composite Service
HTTP Status Codes for Composites
Composite Things: OData Service
Read Metadata of Composite Things
Read Details of a Property Set Type
Read all Property Set Types
Read all Property Sets for a Property Set Type
Read Things for Property Set of a Property Set Type
Composite Events: OData Service
Read Metadata of Composite Events
Read Details of all Event Types
Read Details of an Event Type
Read Events and Event Data for Property Set of a Property Set Type
Read Details of all Events for an Event Type
Read Details of an Event for an Event Type
Composite Thing Configuration for a Specific Thing Hierarchy: OData Service
Read Metadata
Read all Hierarchies
Read Details of a Thing Hierarchy
Read Thing Hierarchy Elements
Read Thing Hierarchy Elements and Property Set Types
Read Thing Hierarchy Elements, Property Set Types, and Properties
Thing Detail
Read Metadata of Thing Detail
Read Details of a Thing
Read Property Set Data for a Thing
Advanced Thing List
Read Metadata of Thing List
Read List of Things
Read Property Set Data and Events for a Thing
Advanced Event List
Read Metadata of Event List
Read List of Events
Event List: OData Service
Read Metadata of Event Type
Read Events of Event Type for Customer
Events Aggregate: OData Service
Read Metadata of Events Aggregate
Read Aggregate of Events
SAP Analytics Cloud Integration
Data Model Consumption in SAP Analytics Cloud
Content Manager
Functional Overview
Data Model Activation
Aggregate Generation
Changes to Master Data and Metadata
Purging Aggregated Data
API Reference
Content Manager Metadata
Read Metadata
Catalog Metadata
Read Catalog Types
Read Catalogs
Read Datasets
Read Properties
Data Model
Create a Data Model
Read a Data Model
Activate a Data Model
Delete a Data Model
Update Master Data and Metadata
Read Data Model Status Log
Authorization Group
Create a New Authorization Group
Read an Authorization Group
Read all Authorization Groups
Update an Authorization Group
Delete an Authorization Group
Content Manager Runtime Service
Read Metadata of Content Manager Runtime Service
Read Data of Content Manager Runtime Service
Monitoring and Logging
Read all Correlations
Read Status of a Correlation ID
Read Log Details of a Correlation
Read Details of a Log
Filter Conditions ($filter)
Retrieving List of Records
Draft Mode for Service Requests
Reserved Keywords for Configuration and Thing Services
Value Data Types for Property Types and Properties
Value Helps
ISO Language Codes
Country Codes
HTTP Status Codes