Interface ProductHierarchyNodeService
- All Known Implementing Classes:
DefaultProductHierarchyNodeService
This synchronous inbound OData service enables external systems and other consumers to read currently active version for a given Hierarchy ID, or the version with a specified validity date. This service also enables external systems and other consumers to create version, nodes, and texts of a product hierarchy. This information is used in the processes related to sales and distribution..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | PRODHIERNODES_0001 |
| API Version: | 1.1.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Product Integration(SAP_COM_0009) |
| Scope Items: | Master Data Integration(1RO), Opportunity-to-Order with SAP Cloud for Customer(1VP) |
| Authentication Methods: | x509 |
| Service Group Name: | API_PROD_HIER_NODES_SRV |
| Business Object: | Product |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theProdUniversalHierarchyentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theProdUniversalHierarchyTextentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theProdUnivHierNodeByHierIDentity collection matching the filter and search expressions.createProdUniversalHierarchy(ProdUniversalHierarchy prodUniversalHierarchy) Deprecated.Create a newProdUniversalHierarchyentity and save it to the S/4HANA system.Deprecated.Fetch multipleProdUniversalHierarchyentities.Deprecated.Fetch multipleProdUniversalHierarchyTextentities.Deprecated.Fetch multipleProdUnivHierNodeByHierIDentities.getProdUniversalHierarchyByKey(String prodUnivHierarchy, LocalDate prodHierarchyValidityEndDate) Deprecated.Fetch a singleProdUniversalHierarchyentity using key fields.getProdUniversalHierarchyTextByKey(String language, String prodUnivHierarchy, LocalDate prodHierarchyValidityEndDate) Deprecated.Fetch a singleProdUniversalHierarchyTextentity using key fields.getProdUnivHierNodeByHierIDByKey(String prodUnivHierarchy, String hierarchyNode, LocalDate prodHierarchyValidityEndDate) Deprecated.Fetch a singleProdUnivHierNodeByHierIDentity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllProdUniversalHierarchy
Deprecated.Fetch multipleProdUniversalHierarchyentities.- Returns:
- A request builder to fetch multiple
ProdUniversalHierarchyentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countProdUniversalHierarchy
Deprecated.Fetch the number of entries from theProdUniversalHierarchyentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ProdUniversalHierarchyentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getProdUniversalHierarchyByKey
@Nonnull GetByKeyRequestBuilder<ProdUniversalHierarchy> getProdUniversalHierarchyByKey(String prodUnivHierarchy, LocalDate prodHierarchyValidityEndDate) Deprecated.Fetch a singleProdUniversalHierarchyentity using key fields.- Parameters:
prodHierarchyValidityEndDate- Validity End DateConstraints: Not nullable
prodUnivHierarchy- Product HierarchyConstraints: Not nullable, Maximum length: 20
- Returns:
- A request builder to fetch a single
ProdUniversalHierarchyentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
createProdUniversalHierarchy
@Nonnull CreateRequestBuilder<ProdUniversalHierarchy> createProdUniversalHierarchy(@Nonnull ProdUniversalHierarchy prodUniversalHierarchy) Deprecated.Create a newProdUniversalHierarchyentity and save it to the S/4HANA system.- Parameters:
prodUniversalHierarchy-ProdUniversalHierarchyentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
ProdUniversalHierarchyentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllProdUniversalHierarchyText
Deprecated.Fetch multipleProdUniversalHierarchyTextentities.- Returns:
- A request builder to fetch multiple
ProdUniversalHierarchyTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countProdUniversalHierarchyText
Deprecated.Fetch the number of entries from theProdUniversalHierarchyTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ProdUniversalHierarchyTextentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getProdUniversalHierarchyTextByKey
@Nonnull GetByKeyRequestBuilder<ProdUniversalHierarchyText> getProdUniversalHierarchyTextByKey(String language, String prodUnivHierarchy, LocalDate prodHierarchyValidityEndDate) Deprecated.Fetch a singleProdUniversalHierarchyTextentity using key fields.- Parameters:
prodHierarchyValidityEndDate- Valid To DateConstraints: Not nullable
prodUnivHierarchy- Product HierarchyConstraints: Not nullable, Maximum length: 20
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
ProdUniversalHierarchyTextentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getAllProdUnivHierNodeByHierID
Deprecated.Fetch multipleProdUnivHierNodeByHierIDentities.- Returns:
- A request builder to fetch multiple
ProdUnivHierNodeByHierIDentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countProdUnivHierNodeByHierID
Deprecated.Fetch the number of entries from theProdUnivHierNodeByHierIDentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
ProdUnivHierNodeByHierIDentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getProdUnivHierNodeByHierIDByKey
@Nonnull GetByKeyRequestBuilder<ProdUnivHierNodeByHierID> getProdUnivHierNodeByHierIDByKey(String prodUnivHierarchy, String hierarchyNode, LocalDate prodHierarchyValidityEndDate) Deprecated.Fetch a singleProdUnivHierNodeByHierIDentity using key fields.- Parameters:
prodHierarchyValidityEndDate- Validity End DateConstraints: Not nullable
prodUnivHierarchy- Product HierarchyConstraints: Not nullable, Maximum length: 20
hierarchyNode- Hierarchy nodeConstraints: Not nullable, Maximum length: 50
- Returns:
- A request builder to fetch a single
ProdUnivHierNodeByHierIDentity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-