PUBLIC 2021-03-09 OData Services company. All rights reserved. All rights company. affiliate THE BEST RUN 2021 SAP SE or an SAP SE or an SAP SAP 2021 © Content 1 SAP Cloud for Customer OData API..............................................4 2 New Features.............................................................. 13 2.1 What's New in OData API v2 Reference.............................................13 2.2 Add Public Solution Model (PSM) Fields to Standard OData Services........................15 2.3 Transport Custom OData Services with Transport Management............................16 2.4 Compatibility Mode for READ Operations........................................... 16 2.5 Support for User-Friendly IDs in Standard OData Services................................16 2.6 Constant Values to Function Imports...............................................17 3 OData API Reference.........................................................18 3.1 OData API v2 Reference........................................................18 3.2 OData API v1 Reference (Deprecated)..............................................20 Account Contact Relationship.................................................21 Account EntityType........................................................22 Appointment Entity Type....................................................40 BusinessPartner Entity Type..................................................46 CodeList Entity Type....................................................... 47 Contextual CodeList Entity Type...............................................48 Contact Entity Type........................................................50 EMail Entity Type..........................................................61 Employee Entity Type.......................................................69 External ID Mapping Entity Type............................................... 77 Individual Customer Entity Type............................................... 78 Lead Entity Type..........................................................88 Sales Lead Entity Type (Deprecated)...........................................108 Opportunity Entity Type.....................................................118 Phone Call Entity Type..................................................... 138 Product Entity Type....................................................... 144 Service Request Entity Type................................................. 152 Task Entity Type..........................................................171 TimeEntry..............................................................177 User Entity Type..........................................................181 Visit Entity Type..........................................................184 Marketing Attributes Entity Type..............................................190 HTTP Status Codes.......................................................196 Service Assignment Entity Type...............................................197 OData Services 2 PUBLIC Content 4 OData Service Explorer..................................................... 203 4.1 Creating an OData Service.....................................................203 4.2 Testing an OData Service......................................................209 5 OData API Monitor......................................................... 217 6 (Deprecated) Setting Up OData Notifications.....................................218 7 SAP Cloud for Customer OData Developer's Guide.................................220 8 Additional Resources....................................................... 221 OData Services Content PUBLIC 3 1 SAP Cloud for Customer OData API The SAP Cloud for Customer OData API conforms to OData version 2 specification. The complete list of collections (or data end-points) of SAP Cloud for Customer OData API, are listed in the OData API Reference section of this document. Related Information OData Version 2.0 Specification SAP Cloud for Customer OData API 2.0 Reference 1.1 Purpose Use the OData API, to query, read, add, update and delete data from and into SAP Cloud for Customer. This document is a reference point for learning SAP Cloud for Customer OData API. You'll find a short introduction to the capabilities of the OData API as well as information on where to find more details. 1.2 What is OData? OData (Open Data Protocol) is an OASIS Standard that defines a protocol for building and consuming RESTful APIs, based on the HTTP protocol. OData differentiates itself from most of the other RESTful APIs, mainly by providing the following: ● Metadata of the entities exposed by the OData service ● Relationship between the entities within an OData service ● System and custom query options for retrieving data The protocol allows filtering data, ordering and paginating of the query results, retrieving number of records, and more. Querying and modifying data is possible in XML (AtomPub) and JSON formats. For more information on OData protocol, please visit to http://www.odata.org, where you can find different versions of OData specifications, community resources (such as OData providers and consumer libraries), sample OData services and tutorials. OData Services 4 PUBLIC SAP Cloud for Customer OData API Related Information https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata http://www.odata.org/ 1.3 Accessing OData API You can access the SAP Cloud for Customer OData API of your tenant, with the URL pattern: https:// <your_tenant>/sap/c4c/odata/v1/c4codataapi 1.4 Accessing Metadata of the OData API You can access the metadata of the OData API of your tenant, with the URL pattern: https:// <YourTenant>/sap/c4c/odata/v1/c4codataapi/$metadata 1.5 Authentication Learn about security options for accessing the SAP Cloud for Customer OData API. Client applications using the OData API, have four options for providing authorization and authentication for their users: ● Basic Authentication ● OAuth 2.0 ● X.509 ● SAML (Security Assertion Markup Language) based single sign-on. Using OAuth 2.0 requires a trust relationship to be configured between SAP Cloud for Customer and the identity provider of your client application in the Administrator work center. See Create Trust Between the Customer Account and SAP Cloud for Customer. OData Services SAP Cloud for Customer OData API PUBLIC 5 1.6 Authorization Authorization of a business user in the user interface is usually the same as the authorization in OData Services. However, there are some exceptions to this behavior. Exceptions to Authorization Behavior See the following table to learn about the exceptions. Behavior in User Interface Use Case Description (UI) Behavior in OData Service Restriction at Work Center Work center view is assigned Work center view is visible OData service with work cen­ without data restriction. ter view assigned has full ac­ View with no restrictions in the Ad­ cess to all data and opera­ ministrator work center. tions. Access Restriction at In­ Work center view is assigned Work center view is visible, OData honors RBAM restric­ stance with Read and Write restric­ and data visibility is re­ tion and limits the access. tion. stricted as configured in user Example: Only opportunities access management. Example: Opportunity with with sales territory 17 are sales territory 17 is restricted Example: User can see op­ available. Create/Update/ (both Read and Write) for the portunities with sales terri­ Delete is restricted for oppor­ user. tory 17 only. tunities with sales territory 17. Restrictions in Field You can use business roles to The object work list (OWL) OData doesn’t honor field re­ restrict (Hide/ReadOnly/ doesn’t hide the restricted striction and field is visible in UnRestricted) the fields (hidden) field, but data isn’t response. (standard and extension) displayed. from the work center views Thing Inspector UI hides the added to business role. restricted field. Example: ExpectedRevenueAmou t field in an opportunity is hidden. Action Restriction You can use business roles to UI restricts user from execut­ Restriction isn’t honored. It’s restrict business object ac­ ing the action. possible to execute the re­ tions. stricted function import. Example: The action Won in Opportunity is restricted for the business role. SAP Key User Tool (KUT) KUT fields with business UI honors KUT adaptations KUT adaptations aren’t hon­ ored. Adaptations logic. Example: KUT field’s visibility based on business role. OData Services 6 PUBLIC SAP Cloud for Customer OData API Behavior in User Interface Use Case Description (UI) Behavior in OData Service UI Switches UI switches are defined by UI switches are honored as UI Switches aren’t honored. custom development and configured. Data encapsulated within can be used to make fields, section groups that is hidden buttons, or sections of user via UI switch is available in interfaces hidden, read-only, OData response. or mandatory. You can use them to assign a particular version of a UI to a business role and to its affected users. Example: A UI section group is read-only. And another one is hidden. To learn more about UI switches, see the blog Make a UI flexible/dynamic using UI Switch . Enhancements to Authorization Assignment Authorization assignments for several OData services are enhanced. With this enhancement, users require the necessary authorizations to consume these OData services. In previous releases, your users may have been able to consume the impacted OData services without the necessary authorization assignments.