Further information about the entity types included in the basic OData sample service for SAP Gateway Foundation (component SAP_GWFND).
BusinessPartner
A business partner can be considered as a company and it can act in two roles, as a customer in a sales order or as a supplier for a product. A business partner is uniquely identified by its BusinessPartnerID property. The BusinessPartner entity type in the data model of this sample service contains the ChangedAt timestamp field as an Etag and contains the change-at timestamp in the long format. Consequently, you must provide an If-Match header in each update or delete request you submit. If you do not provider an If-Match header, an error occurs and the request cannot be executed. The Etag has to be retrieved with a preceding read request. As a workaround you can enter If-Match=*. For more information, see ETag Handling.
If you delete a business partner, all the contact persons related to that business partner are also deleted.
Property | Description | Related Entity Set |
---|---|---|
Address | Based on complex type CT_Address | n/a |
Business Partner ID | Primary key. Unique ID that identifies an EPM Business Partner | n/a |
CompanyName | Company name | n/a |
WebAddress | Web address | n/a |
EMailAddress | Email address | n/a |
PhoneNumber | Phone number | n/a |
FaxNumber | Fax number | n/a |
LegalForm | Legal form | n/a |
CurrencyCode | Currency code | VH_CurrencySet |
BusinessPartnerRole | Business partner role | VH_BPRoleSet |
CreatedAt | Timestamp - Created at | n/a |
ChangedAt | Timestamp - Change at | n/a |
Operation | URI |
---|---|
Query all entries | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet |
Query all entries with sorting | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet?$orderby=Address/Country,Address/City desc |
Query with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet?$filter=((Address/PostalCode ne '69190' and LegalForm eq 'GmbH') or Address/Country eq 'CA') and CreatedAt gt datetime'2014-06-01T08%3A16%3A16.0000000' |
Query with filter, client-side paging and inline count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet?$filter=((Address/PostalCode ne '69190' and LegalForm eq 'GmbH') or Address/Country eq 'CA') and CreatedAt gt datetime'2014-06-01T08%3A16%3A16.0000000'&$skip=1&$top=5&$inlinecount=allpages |
Single read | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet('0100000002') |
Single read with expand | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet('0100000002')?$expand=ToSalesOrders,ToContacts,ToProducts |
Single read with navigation | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet('0100000002')/ToSalesOrders |
Single read with multiple navigation steps | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet('0100000002')/ToSalesOrders('0500000010')/ToLineItems(SalesOrderID='0500000010',ItemPosition='0000000040')/ToProduct |
Count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet/$count |
Count with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/BusinessPartnerSet/$count?$filter=Address/City eq 'Walldorf' |
You can execute these URIs in the SAP Gateway Client provided that EPM data has been generated. Note that the contact GUIDs are generated for each system meaning that you must enter a valid GUID from your system into the Single read examples provided above.
Contact Person
A contact person can be considered a physical person, but they cannot exist in isolation and must always belong to a business partner identified by the BusinessPartnerID property. A contact person is uniquely identified by its ContactGUID property.
Property | Description | Related Entity Set |
---|---|---|
Address | Based on complex type CT_Address | n/a |
ContactGUID | Primary key. Unique GUID that identifies EPM contact | n/a |
BusinessPartnerID | Business partner ID | BusinessPartnerSet |
Title | Title | n/a |
FirstName | First name | n/a |
MiddleName | Middle name | n/a |
LastName | Last name | n/a |
NickName | Nickname | n/a |
Initials | Initials | n/a |
Sex | Gender | VH_SexSet |
PhoneNumber | Telephone number | n/a |
FaxNumber | Fax number | n/a |
EmailAddress | Email address | n/a |
Language | Language | VH_LanguageSet |
DateOfBirth | Date of birth | n/a |
Operation | URI |
---|---|
Query all entries | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet |
Query all entries with sorting | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet?$orderby=LastName,FirstName |
Query with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet?$filter=substringof(Address/Building,'4') and MiddleName eq '' and endswith(EmailAddress,'com') |
Query with filter, client-side paging and inline count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet?$filter=substringof(Address/Building,'4') and MiddleName eq ''&$skip=1&$top=5&$inlinecount=allpages |
Single read | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet(guid'<a valid GUID from the query>') |
Single read with expand | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet(guid'<a valid GUID from the query>')?$expand=ToBusinessPartner |
Single read with navigation | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet(guid'<a valid GUID from the query>')/ToBusinessPartner |
Single read with multiple navigation steps | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet(guid'<a valid GUID from the query>')/ToBusinessPartner/ToProducts('HT-1001')/ToSalesOrderLineItems |
Count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet/$count |
Count with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ContactSet/$count?$filter=Address/Country eq 'US' |
You can execute these URIs in the SAP Gateway Client provided that EPM data has been generated. Note that the contact GUIDs are generated for each system meaning that you must enter a valid GUID from your system into the Single read examples provided above.
Product
A product is an entity that can be sold using a sales order line item. A product can be uniquely identified by its ProductID property and is supplied by a business partner identified by the SupplierID property. The Name and Description properties of a product are language-dependent texts and can, as such, be edited.
Entity type name: Product
Entity set name: ProductSet
Underlying DDIC structure: /IWBEP/S_BGWS_BASIC_PRODUCT
Property | Description | Related Entity Set |
---|---|---|
ProductID | Primary key. Unique ID that identifies an EPM product | n/a |
TypeCode | Defines the type of product (for example, regular product or advertisment) | VH_ProductTypeCodeSet |
Category | Product category (for example, laser printers, smart phones) | VH_CategorySet |
Name | Product name | n/a |
NameLanguage | Language of the product name | VH_LanguageSet |
Description | Product description | n/a |
DescriptionLanguage | Language of the product description | VH_LanguageSet |
SupplierID | ID of the business partner that supplies the product | BusinessPartnerSet |
SupplierName | Name of supplier | n/a |
TaxTarifCode | Tax tarif code (for example, '1'-Regular VAT, '2'-Reduced, '3'-No VAT) | n/a |
MeasureUnit | Measure unit of the product (for example, 'EA'-Each) | VH_QuantitySet |
WeightMeasure | Weight of the product | n/a |
WeightUnit | Weight unit for WeightMeasure (for example, 'KG'-Kilo) | VH_UnitWeightSet |
CurrencyCode | Currency code (for example, 'EUR'-Euro) | VH_CurrencySet |
Price | Price | n/a |
Width | Width | n/a |
Depth | Depth | n/a |
Height | Height | n/a |
DimUnit | Dimension unit for width, depth, height | VH_UnitLength |
CreatedAt | Timestamp - Created at | n/a |
ChangedAt | Timestamp - Changed at (used as Etag property) | n/a |
Operation | URI |
---|---|
Query all entries | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet |
Query all entries with sorting | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet?$orderby=Category,ProductID desc |
Query with filter and sorting | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet?$filter=SupplierID eq '0100000015'&$orderby=Price desc |
Query with filter, client-side paging and inline count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet?$filter=Category eq 'PDAs/Organizers' or Price gt 2000&$skip=0&$top=4&$inlinecount=allpages |
Single read | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet('HT-1000') |
Single read with expand | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet('HT-1002')/?$expand=ToSupplier,ToSalesOrderLineItems |
Single read with navigation | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet('HT-1010')/ToSupplier |
Single read with multiple navigation steps | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet('HT-1010')/ToSalesOrderLineItems(SalesOrderID='0500000012',ItemPosition='0000000060')/ToHeader |
Count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet/$count |
Count with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ProductSet/$count?$filter=CurrencyCode ne 'EUR' |
Sales Order
Property | Description | Related Entity Set |
---|---|---|
SalesOrderID | Primary key. Unique ID that identifies an EPM sales order | n/a |
Note | Descriptive note | n/a |
NoteLanguage | Language of the note | VH_LanguageSet |
CustomerID | ID of sales order customer | BusinessPartnerSet |
CustomerName | Names of the sales order customer | n/a |
CurrencyCode | Currency code for gross amount, net amount, and tax amount (for example 'EUR') | VH_CurrencySet |
GrossAmount | Gross amount | n/a |
NetAmount | Net amount | n/a |
TaxAmount | Tax amount | n/a |
LifecycleStatus | Lifecycle status (for example, 'N'-New, 'P'-In Progress, 'C'-Closed, 'X'-Canceled) | |
LifecycleStatusDescription | Description (long text) of lifecycle status | n/a |
BillingStatus | Billing status (for example, ' '-Initial, 'P'-Paid) | n/a |
BillingStatusDescription | Description (long text) of billing status | n/a |
DeliveryStatus | Delivery status (for example, ' '-Initial, 'D'-Delivered) | n/a |
DeliveryStatusDescription | Description (long text) of delivery status | n/a |
CreatedAt | Timestamp - created at | n/a |
ChangedAt | Timestamp - changed at (used as Etag property) | n/a |
Operation | URI |
---|---|
Query all entries | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet |
Query all entries with sorting | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet?$orderby=CustomerName desc,GrossAmount |
Query with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet?$filter=CurrencyCode eq 'EUR' and GrossAmount gt 5000 |
Query with filter, client-side paging and inline count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet?$filter=SalesOrderID gt '0500000002' and SalesOrderID lt '0500000018'&$skip=2&$top=4&$inlinecount=allpages |
Single read | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet('0500000004') |
Single read with expand | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet('0500000004')?$expand=ToLineItems |
Single read with navigation | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet('0500000004')/ToBusinessPartner |
Single read with multiple navigation steps | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet('0500000004')/ToLineItems(SalesOrderID='0500000004',ItemPosition='0000000030')/ToProduct/ToSupplier |
Count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet/$count |
Count with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderSet/$count?$filter=TaxAmount lt 500 |
Sales Order Line Item
Property | Description | Related Entity Set |
---|---|---|
SalesOrderID | Primary key. Unique ID that identifies an EPM sales order | SalesOrderSet |
ItemPosition | Primary key. ID of a sales order line item | n/a |
ProductID | ID of the product | ProductSet |
Note | Descriptive note | n/a |
NoteLanguage | Language of note | VH_LanguageSet |
CurrencyCode | Currency code for gross amount, net amount, and tax amount (for example 'EUR') | VH_CurrencySet |
GrossAmount | Gross amount | n/a |
NetAmount | Net amount | n/a |
TaxAmount | Tax amount | n/a |
DeliveryDate | Expected delivery date | n/a |
Quantity | Quanity | n/a |
QuantityUnit | Unit of the quantity (for example, 'EA'-Each) | VH_UnitQuantitySet |
Operation | URI |
---|---|
Query all entries | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet |
Query all entries with sorting | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet?$orderby=SalesOrderID,ItemPosition |
Query with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet?$filter=SalesOrderID gt '0500000005' and SalesOrderID lt '0500000015' and GrossAmount gt 3000 |
Query with filter, client-side paging and inline count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet?$filter=startswith(ProductID,'HT-') and CurrencyCode eq 'MXN'&$skip=0&$top=3&$inlinecount=allpages |
Single read | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet(SalesOrderID='0500000009',ItemPosition='0000000010') |
Single read with expand | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet(SalesOrderID='0500000009',ItemPosition='0000000010')?$expand=ToHeader |
Single read with navigation | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet(SalesOrderID='0500000009',ItemPosition='0000000010')/ToProduct |
Single read with multiple navigation steps | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet(SalesOrderID='0500000014',ItemPosition='0000000020')/ToHeader/ToLineItems(SalesOrderID='0500000014',ItemPosition='0000000020')/ToProduct/ToSupplier |
Count | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet/$count |
Count with filter | /sap/opu/odata/IWBEP/GWSAMPLE_BASIC/SalesOrderLineItemSet/$count?$filter=TaxAmount gt 180 and TaxAmount lt 250 |