Interface LabelTemplateMetadataService
- All Known Implementing Classes:
DefaultLabelTemplateMetadataService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the
VDM.
This service enables you to create or update existing metadata from your SAP S/4HANA system as a result of the design of label templates in external systems. The service provides relevant information about label template metadata, such as name, version, list of used label field versions (from the OData API: ***Label Field Catalog***)..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | CE_LABELTEMPLATEMETADATA_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_PCLBLTEMPLATEMETADATA |
| Business Object: | Product Compliance Label Template |
-
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 theLabelTemplateentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelTemplateVersionentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theLabelTemplateVersUsedFieldVersentity collection matching the filter and search expressions.createLabelTemplate(LabelTemplate labelTemplate) Deprecated.Create a newLabelTemplateentity and save it to the S/4HANA system.createLabelTemplateVersion(LabelTemplateVersion labelTemplateVersion) Deprecated.Create a newLabelTemplateVersionentity and save it to the S/4HANA system.deleteLabelTemplateVersUsedFieldVers(LabelTemplateVersUsedFieldVers labelTemplateVersUsedFieldVers) Deprecated.Deletes an existingLabelTemplateVersUsedFieldVersentity in the S/4HANA system.Deprecated.Fetch multipleLabelTemplateentities.Deprecated.Fetch multipleLabelTemplateVersionentities.Deprecated.Fetch multipleLabelTemplateVersUsedFieldVersentities.getLabelTemplateByKey(String pCLblTemplateID) Deprecated.Fetch a singleLabelTemplateentity using key fields.getLabelTemplateVersionByKey(String pCLblTemplateVersionID) Deprecated.Fetch a singleLabelTemplateVersionentity using key fields.getLabelTemplateVersUsedFieldVersByKey(String prodCmplncLabelFieldVersionID, String pCLblTemplateVersionID) Deprecated.Fetch a singleLabelTemplateVersUsedFieldVersentity using key fields.updateLabelTemplate(LabelTemplate labelTemplate) Deprecated.Update an existingLabelTemplateentity and save it to the S/4HANA system.updateLabelTemplateVersion(LabelTemplateVersion labelTemplateVersion) Deprecated.Update an existingLabelTemplateVersionentity and save it to the S/4HANA system.updateLabelTemplateVersUsedFieldVers(LabelTemplateVersUsedFieldVers labelTemplateVersUsedFieldVers) Deprecated.Update an existingLabelTemplateVersUsedFieldVersentity and save it to the S/4HANA system.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.
-
getAllLabelTemplate
Deprecated.Fetch multipleLabelTemplateentities.- Returns:
- A request builder to fetch multiple
LabelTemplateentities. 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.
-
countLabelTemplate
Deprecated.Fetch the number of entries from theLabelTemplateentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelTemplateentities. 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.
-
getLabelTemplateByKey
Deprecated.Fetch a singleLabelTemplateentity using key fields.- Parameters:
pCLblTemplateID- IdentifierConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelTemplateentity 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.
-
createLabelTemplate
@Nonnull CreateRequestBuilder<LabelTemplate> createLabelTemplate(@Nonnull LabelTemplate labelTemplate) Deprecated.Create a newLabelTemplateentity and save it to the S/4HANA system.- Parameters:
labelTemplate-LabelTemplateentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
LabelTemplateentity. To perform execution, call theexecutemethod on the request builder object.
-
updateLabelTemplate
@Nonnull UpdateRequestBuilder<LabelTemplate> updateLabelTemplate(@Nonnull LabelTemplate labelTemplate) Deprecated.Update an existingLabelTemplateentity and save it to the S/4HANA system.- Parameters:
labelTemplate-LabelTemplateentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
LabelTemplateentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllLabelTemplateVersion
Deprecated.Fetch multipleLabelTemplateVersionentities.- Returns:
- A request builder to fetch multiple
LabelTemplateVersionentities. 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.
-
countLabelTemplateVersion
Deprecated.Fetch the number of entries from theLabelTemplateVersionentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelTemplateVersionentities. 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.
-
getLabelTemplateVersionByKey
@Nonnull GetByKeyRequestBuilder<LabelTemplateVersion> getLabelTemplateVersionByKey(String pCLblTemplateVersionID) Deprecated.Fetch a singleLabelTemplateVersionentity using key fields.- Parameters:
pCLblTemplateVersionID- IdentifierConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelTemplateVersionentity 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.
-
createLabelTemplateVersion
@Nonnull CreateRequestBuilder<LabelTemplateVersion> createLabelTemplateVersion(@Nonnull LabelTemplateVersion labelTemplateVersion) Deprecated.Create a newLabelTemplateVersionentity and save it to the S/4HANA system.- Parameters:
labelTemplateVersion-LabelTemplateVersionentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
LabelTemplateVersionentity. To perform execution, call theexecutemethod on the request builder object.
-
updateLabelTemplateVersion
@Nonnull UpdateRequestBuilder<LabelTemplateVersion> updateLabelTemplateVersion(@Nonnull LabelTemplateVersion labelTemplateVersion) Deprecated.Update an existingLabelTemplateVersionentity and save it to the S/4HANA system.- Parameters:
labelTemplateVersion-LabelTemplateVersionentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
LabelTemplateVersionentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllLabelTemplateVersUsedFieldVers
@Nonnull GetAllRequestBuilder<LabelTemplateVersUsedFieldVers> getAllLabelTemplateVersUsedFieldVers()Deprecated.Fetch multipleLabelTemplateVersUsedFieldVersentities.- Returns:
- A request builder to fetch multiple
LabelTemplateVersUsedFieldVersentities. 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.
-
countLabelTemplateVersUsedFieldVers
Deprecated.Fetch the number of entries from theLabelTemplateVersUsedFieldVersentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
LabelTemplateVersUsedFieldVersentities. 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.
-
getLabelTemplateVersUsedFieldVersByKey
@Nonnull GetByKeyRequestBuilder<LabelTemplateVersUsedFieldVers> getLabelTemplateVersUsedFieldVersByKey(String prodCmplncLabelFieldVersionID, String pCLblTemplateVersionID) Deprecated.Fetch a singleLabelTemplateVersUsedFieldVersentity using key fields.- Parameters:
pCLblTemplateVersionID- IdentifierConstraints: Not nullable, Maximum length: 21
prodCmplncLabelFieldVersionID- Label Field Version IdentificatorConstraints: Not nullable, Maximum length: 21
- Returns:
- A request builder to fetch a single
LabelTemplateVersUsedFieldVersentity 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.
-
updateLabelTemplateVersUsedFieldVers
@Nonnull UpdateRequestBuilder<LabelTemplateVersUsedFieldVers> updateLabelTemplateVersUsedFieldVers(@Nonnull LabelTemplateVersUsedFieldVers labelTemplateVersUsedFieldVers) Deprecated.Update an existingLabelTemplateVersUsedFieldVersentity and save it to the S/4HANA system.- Parameters:
labelTemplateVersUsedFieldVers-LabelTemplateVersUsedFieldVersentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
LabelTemplateVersUsedFieldVersentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteLabelTemplateVersUsedFieldVers
@Nonnull DeleteRequestBuilder<LabelTemplateVersUsedFieldVers> deleteLabelTemplateVersUsedFieldVers(@Nonnull LabelTemplateVersUsedFieldVers labelTemplateVersUsedFieldVers) Deprecated.Deletes an existingLabelTemplateVersUsedFieldVersentity in the S/4HANA system.- Parameters:
labelTemplateVersUsedFieldVers-LabelTemplateVersUsedFieldVersentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
LabelTemplateVersUsedFieldVersentity. To perform execution, call theexecutemethod on the request builder object.
-