Interface LabelFieldCatalogService
- All Known Implementing Classes:
DefaultLabelFieldCatalogService
This service enables you to retrieve label field placeholders from your SAP S/4HANA system and use them in the process of designing label templates in external systems. The service contains all relevant information about a label field placeholder such as ID, version, and the group that it belongs to..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | LABELFIELDCATALOG_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Product Compliance - Label Template Authoring Integration(SAP_COM_0772) |
| Scope Items: | Label Management(6MT) |
| Authentication Methods: | x509 |
| Service Group Name: | API_PRODCMPLNCLBLFLDCTLG |
| Business Object: | Product Compliance Label Field Group |
-
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 theLabelFieldGroupentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelFieldGroupTextentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelFieldVersionentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelFieldVersionTextentity collection matching the filter and search expressions.Deprecated.Fetch multipleLabelFieldGroupentities.Deprecated.Fetch multipleLabelFieldGroupTextentities.Deprecated.Fetch multipleLabelFieldVersionentities.Deprecated.Fetch multipleLabelFieldVersionTextentities.getLabelFieldGroupByKey(String prodCmplncLabelFieldGroupID) Deprecated.Fetch a singleLabelFieldGroupentity using key fields.getLabelFieldGroupTextByKey(String prodCmplncLabelFieldGroupID, String language) Deprecated.Fetch a singleLabelFieldGroupTextentity using key fields.getLabelFieldVersionByKey(String prodCmplncLabelFieldVersionID) Deprecated.Fetch a singleLabelFieldVersionentity using key fields.getLabelFieldVersionTextByKey(String prodCmplncLabelFieldVersionID, String language) Deprecated.Fetch a singleLabelFieldVersionTextentity 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.
-
getAllLabelFieldGroup
Deprecated.Fetch multipleLabelFieldGroupentities.- Returns:
- A request builder to fetch multiple
LabelFieldGroupentities. 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.
-
countLabelFieldGroup
Deprecated.Fetch the number of entries from theLabelFieldGroupentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelFieldGroupentities. 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.
-
getLabelFieldGroupByKey
@Nonnull GetByKeyRequestBuilder<LabelFieldGroup> getLabelFieldGroupByKey(String prodCmplncLabelFieldGroupID) Deprecated.Fetch a singleLabelFieldGroupentity using key fields.- Parameters:
prodCmplncLabelFieldGroupID- Label Field Group IDConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelFieldGroupentity 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.
-
getAllLabelFieldGroupText
Deprecated.Fetch multipleLabelFieldGroupTextentities.- Returns:
- A request builder to fetch multiple
LabelFieldGroupTextentities. 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.
-
countLabelFieldGroupText
Deprecated.Fetch the number of entries from theLabelFieldGroupTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelFieldGroupTextentities. 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.
-
getLabelFieldGroupTextByKey
@Nonnull GetByKeyRequestBuilder<LabelFieldGroupText> getLabelFieldGroupTextByKey(String prodCmplncLabelFieldGroupID, String language) Deprecated.Fetch a singleLabelFieldGroupTextentity using key fields.- Parameters:
prodCmplncLabelFieldGroupID- Label Field Group IDConstraints: Not nullable, Maximum length: 21
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
LabelFieldGroupTextentity 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.
-
getAllLabelFieldVersion
Deprecated.Fetch multipleLabelFieldVersionentities.- Returns:
- A request builder to fetch multiple
LabelFieldVersionentities. 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.
-
countLabelFieldVersion
Deprecated.Fetch the number of entries from theLabelFieldVersionentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelFieldVersionentities. 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.
-
getLabelFieldVersionByKey
@Nonnull GetByKeyRequestBuilder<LabelFieldVersion> getLabelFieldVersionByKey(String prodCmplncLabelFieldVersionID) Deprecated.Fetch a singleLabelFieldVersionentity using key fields.- Parameters:
prodCmplncLabelFieldVersionID- Label Field Version IdentificatorConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelFieldVersionentity 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.
-
getAllLabelFieldVersionText
Deprecated.Fetch multipleLabelFieldVersionTextentities.- Returns:
- A request builder to fetch multiple
LabelFieldVersionTextentities. 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.
-
countLabelFieldVersionText
Deprecated.Fetch the number of entries from theLabelFieldVersionTextentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelFieldVersionTextentities. 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.
-
getLabelFieldVersionTextByKey
@Nonnull GetByKeyRequestBuilder<LabelFieldVersionText> getLabelFieldVersionTextByKey(String prodCmplncLabelFieldVersionID, String language) Deprecated.Fetch a singleLabelFieldVersionTextentity using key fields.- Parameters:
language- Language KeyConstraints: Not nullable, Maximum length: 2
prodCmplncLabelFieldVersionID- Label Field Version IdentificatorConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelFieldVersionTextentity 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.
-