public interface CatalogTypeCodingService
This service contains catalog groups and codes that belong to catalog type D which is Coding. The catalog type Coding is used in maintenance notification to record the failure modes. The information is sent in the request as a payload. The request payload contains all information required to read the catalog type Coding. All the information in the payload is used to read Coding as a catalog type and includes appropriate checks for restricted values and authorizations. Once the coding has been read, the response with the data is included. If the input in the request is not as expected when you read the catalog type Coding, the system displays appropriate error or warning messages in the response. .
Reference: SAP API Business Hub
OData Service: | CODING_0001 |
API Version: | 1 |
Communication Scenario: | Maintenance Processing Integration (SAP_COM_0397) |
Scope Items: | Reactive Maintenance (4HH), Proactive Maintenance (4HI), Improvement Maintenance (4VT), Operational and Overhead Maintenance (4WM), Corrective Maintenance (BH1), Emergency Maintenance (BH2), Preventive Maintenance (BJ2) |
Authentication Methods: | Basic, x509, OAuth2 |
Service Group Name: | API_CODING |
Business Object: | MaintenanceNotification |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path
used to access the endpoint. |
Modifier and Type | Method and Description |
---|---|
BatchRequestBuilder |
batch()
Creates a batch request builder object.
|
CountRequestBuilder<MaintNotifCodingCode> |
countMaintNotifCodingCode()
Fetch the number of entries from the
MaintNotifCodingCode entity collection matching the filter and search expressions. |
GetAllRequestBuilder<MaintNotifCodingCode> |
getAllMaintNotifCodingCode()
Fetch multiple
MaintNotifCodingCode entities. |
GetByKeyRequestBuilder<MaintNotifCodingCode> |
getMaintNotifCodingCodeByKey(String maintNotifCodingCatalog,
String maintNotifCodingCodeGroup,
String maintNotifCodingCode)
Fetch a single
MaintNotifCodingCode entity using key fields. |
CatalogTypeCodingService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull CatalogTypeCodingService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BatchRequestBuilder batch()
execute
method on the request builder object.@Nonnull GetAllRequestBuilder<MaintNotifCodingCode> getAllMaintNotifCodingCode()
MaintNotifCodingCode
entities.MaintNotifCodingCode
entities. This request builder allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the request builder object.@Nonnull CountRequestBuilder<MaintNotifCodingCode> countMaintNotifCodingCode()
MaintNotifCodingCode
entity collection matching the filter and search expressions.MaintNotifCodingCode
entities. This request builder allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the request builder object.@Nonnull GetByKeyRequestBuilder<MaintNotifCodingCode> getMaintNotifCodingCodeByKey(@Nonnull String maintNotifCodingCatalog, @Nonnull String maintNotifCodingCodeGroup, @Nonnull String maintNotifCodingCode)
MaintNotifCodingCode
entity using key fields.maintNotifCodingCode
- Code
Constraints: Not nullable, Maximum length: 4
maintNotifCodingCodeGroup
- Code Group
Constraints: Not nullable, Maximum length: 8
maintNotifCodingCatalog
- Catalog
Constraints: Not nullable, Maximum length: 1
MaintNotifCodingCode
entity 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 the
execute
method on the request builder object.Copyright © 2021 SAP SE. All rights reserved.