public interface EquipmentService extends BatchService<EquipmentServiceBatch>
This service contains equipment, long text, partner function, warranty, class, characteristic, and characteristic value nodes. The information is sent in the request as a payload. The request payload contains all information required to create or update an equipment. All the information in the payload is used to create or update an equipment including appropriate checks for restricted values and authorizations. Once the equipment has been created, the equipment number is sent in the response with the data included in the equipment. If the input in the request is not as expected when you create or update an equipment, the system displays appropriate error or warning messages in the response..
Reference: SAP API Business Hub
OData Service: | API_EQUIPMENT |
API Version: | 1 |
Communication Scenario: | Asset Management Master Data Integration (SAP_COM_0395) |
Scope Items: | Service Order Management and Monitoring (3D2), Service Contract Management (3MO), In-House Repair (3XK), Service Order Processing with SAP Field Service Management (49X), Service Quotation (4GA), Corrective Maintenance (BH1), Emergency Maintenance (BH2), Preventive Maintenance (BJ2) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | Equipment |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull EquipmentService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull EquipmentFluentHelper getAllEquipment()
Equipment
entities.@Nonnull EquipmentByKeyFluentHelper getEquipmentByKey(String equipment, LocalDateTime validityEndDate)
Equipment
entity
using key fields.equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
validityEndDate
- Date indicating up to when an entry is valid.
Constraints: Not nullable, Precision: 0
Equipment
entity using
key fields. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentCreateFluentHelper createEquipment(@Nonnull Equipment equipment)
Equipment
entity and
save it to the S/4HANA system.@Nonnull EquipmentUpdateFluentHelper updateEquipment(@Nonnull Equipment equipment)
Equipment
entity and save it to the S/4HANA system.@Nonnull EquipClassCharacteristicValueFluentHelper getAllEquipClassCharacteristicValue()
EquipClassCharacteristicValue
entities.EquipClassCharacteristicValue
entities. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipClassCharacteristicValueByKeyFluentHelper getEquipClassCharacteristicValueByKey(String equipment, String classType, String charcValuePositionNumber, String characteristicInternalID)
EquipClassCharacteristicValue
entity using key fields.charcValuePositionNumber
- Characteristic value counter
Constraints: Not nullable, Maximum length: 3
characteristicInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
classType
- Uniquely identifies the class type
Constraints: Not nullable, Maximum length: 3
EquipClassCharacteristicValue
entity using key fields. This fluent helper allows methods which modify
the underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipClassCharacteristicValueCreateFluentHelper createEquipClassCharacteristicValue(@Nonnull EquipClassCharacteristicValue equipClassCharacteristicValue)
EquipClassCharacteristicValue
entity and save it to the S/4HANA system.equipClassCharacteristicValue
- EquipClassCharacteristicValue
entity object that will be created in the S/4HANA system.EquipClassCharacteristicValue
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipClassCharacteristicValueUpdateFluentHelper updateEquipClassCharacteristicValue(@Nonnull EquipClassCharacteristicValue equipClassCharacteristicValue)
EquipClassCharacteristicValue
entity and save it to the S/4HANA system.equipClassCharacteristicValue
- EquipClassCharacteristicValue
entity object that will be updated in the S/4HANA system.EquipClassCharacteristicValue
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassFluentHelper getAllEquipmentClass()
EquipmentClass
entities.EquipmentClass
entities. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassByKeyFluentHelper getEquipmentClassByKey(String equipment, String classInternalID, String classType)
EquipmentClass
entity using key fields.classInternalID
- Internal Class Number
Constraints: Not nullable, Maximum length: 10
equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
classType
- Uniquely identifies the class type
Constraints: Not nullable, Maximum length: 3
EquipmentClass
entity using key fields. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassCreateFluentHelper createEquipmentClass(@Nonnull EquipmentClass equipmentClass)
EquipmentClass
entity and save it to the S/4HANA system.equipmentClass
- EquipmentClass
entity object that will be created in the S/4HANA system.EquipmentClass
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassUpdateFluentHelper updateEquipmentClass(@Nonnull EquipmentClass equipmentClass)
EquipmentClass
entity and save it to the S/4HANA system.equipmentClass
- EquipmentClass
entity object that will be updated in the S/4HANA system.EquipmentClass
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassDeleteFluentHelper deleteEquipmentClass(@Nonnull EquipmentClass equipmentClass)
EquipmentClass
entity in the S/4HANA system.equipmentClass
- EquipmentClass
entity object that will be deleted in the S/4HANA system.EquipmentClass
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassCharacteristicFluentHelper getAllEquipmentClassCharacteristic()
EquipmentClassCharacteristic
entities.EquipmentClassCharacteristic
entities. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassCharacteristicByKeyFluentHelper getEquipmentClassCharacteristicByKey(String equipment, String classInternalID, String characteristicInternalID)
EquipmentClassCharacteristic
entity using key fields.classInternalID
- Internal Class Number
Constraints: Not nullable, Maximum length: 10
characteristicInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
EquipmentClassCharacteristic
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentClassCharacteristicCreateFluentHelper createEquipmentClassCharacteristic(@Nonnull EquipmentClassCharacteristic equipmentClassCharacteristic)
EquipmentClassCharacteristic
entity and save it to the S/4HANA system.equipmentClassCharacteristic
- EquipmentClassCharacteristic
entity object that will be created in the S/4HANA system.EquipmentClassCharacteristic
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentLongTextFluentHelper getAllEquipmentLongText()
EquipmentLongText
entities.EquipmentLongText
entities. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentLongTextByKeyFluentHelper getEquipmentLongTextByKey(String equipment)
EquipmentLongText
entity using key fields.equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
EquipmentLongText
entity using key fields. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentLongTextCreateFluentHelper createEquipmentLongText(@Nonnull EquipmentLongText equipmentLongText)
EquipmentLongText
entity and save it to the S/4HANA system.equipmentLongText
- EquipmentLongText
entity object that will be created in the S/4HANA system.EquipmentLongText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentLongTextUpdateFluentHelper updateEquipmentLongText(@Nonnull EquipmentLongText equipmentLongText)
EquipmentLongText
entity and save it to the S/4HANA system.equipmentLongText
- EquipmentLongText
entity object that will be updated in the S/4HANA system.EquipmentLongText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentPartnerFluentHelper getAllEquipmentPartner()
EquipmentPartner
entities.EquipmentPartner
entities. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentPartnerByKeyFluentHelper getEquipmentPartnerByKey(String equipment, String partnerFunction, String equipmentPartnerObjectNmbr)
EquipmentPartner
entity using key fields.partnerFunction
- You can convert the keys that identify the partner functions in the original German system to
language-specific keys. The converted keys then appear according to the language in which the user
logs on.
Constraints: Not nullable, Maximum length: 2
equipmentPartnerObjectNmbr
- Counter for differentiation 6-digit
Constraints: Not nullable, Maximum length: 6
equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
EquipmentPartner
entity using key fields. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentPartnerCreateFluentHelper createEquipmentPartner(@Nonnull EquipmentPartner equipmentPartner)
EquipmentPartner
entity and save it to the S/4HANA system.equipmentPartner
- EquipmentPartner
entity object that will be created in the S/4HANA system.EquipmentPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentPartnerUpdateFluentHelper updateEquipmentPartner(@Nonnull EquipmentPartner equipmentPartner)
EquipmentPartner
entity and save it to the S/4HANA system.equipmentPartner
- EquipmentPartner
entity object that will be updated in the S/4HANA system.EquipmentPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentWarrantyFluentHelper getAllEquipmentWarranty()
EquipmentWarranty
entities.EquipmentWarranty
entities. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentWarrantyByKeyFluentHelper getEquipmentWarrantyByKey(String equipment, String warrantyType)
EquipmentWarranty
entity using key fields.equipment
- Number by which a piece of equipment can be clearly identified.
Constraints: Not nullable, Maximum length: 18
warrantyType
- Key that describes the warranty type. The warranty type is assigned to an internal warranty category
that specifies whether you are the warrantee or the guarantor.
Constraints: Not nullable, Maximum length: 1
EquipmentWarranty
entity using key fields. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentWarrantyCreateFluentHelper createEquipmentWarranty(@Nonnull EquipmentWarranty equipmentWarranty)
EquipmentWarranty
entity and save it to the S/4HANA system.equipmentWarranty
- EquipmentWarranty
entity object that will be created in the S/4HANA system.EquipmentWarranty
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull EquipmentWarrantyUpdateFluentHelper updateEquipmentWarranty(@Nonnull EquipmentWarranty equipmentWarranty)
EquipmentWarranty
entity and save it to the S/4HANA system.equipmentWarranty
- EquipmentWarranty
entity object that will be updated in the S/4HANA system.EquipmentWarranty
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull DismantleEquipmentFluentHelper dismantleEquipment(String equipment, LocalDateTime validityEndDate, String superordinateEquipment, String equipInstallationPositionNmbr, String functionalLocation, LocalDateTime equipmentInstallationDate, LocalTime equipmentInstallationTime)
Creates a fluent helper for the DismantleEquipment OData function import.
superordinateEquipment
- Superord. Equipment
Constraints: Nullable, Maximum length: 18
Original parameter name from the Odata EDM: SuperordinateEquipment
functionalLocation
- Functional Location
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: FunctionalLocation
equipmentInstallationTime
- Time
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: EquipmentInstallationTime
equipment
- Equipment
Constraints: Not nullable, Maximum length: 18
Original parameter name from the Odata EDM: Equipment
equipInstallationPositionNmbr
- Item (SD)
Constraints: Nullable, Maximum length: 6
Original parameter name from the Odata EDM: EquipInstallationPositionNmbr
validityEndDate
- Valid To
Constraints: Not nullable, Precision: 0
Original parameter name from the Odata EDM: ValidityEndDate
equipmentInstallationDate
- Changed On
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: EquipmentInstallationDate
execute
method on the fluent helper object.@Nonnull InstallEquipmentFluentHelper installEquipment(String equipment, LocalDateTime validityEndDate, String superordinateEquipment, String equipInstallationPositionNmbr, String functionalLocation, LocalDateTime equipmentInstallationDate, LocalTime equipmentInstallationTime)
Creates a fluent helper for the InstallEquipment OData function import.
superordinateEquipment
- Superord. Equipment
Constraints: Nullable, Maximum length: 18
Original parameter name from the Odata EDM: SuperordinateEquipment
functionalLocation
- Functional Location
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: FunctionalLocation
equipmentInstallationTime
- Time
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: EquipmentInstallationTime
equipment
- Equipment
Constraints: Not nullable, Maximum length: 18
Original parameter name from the Odata EDM: Equipment
equipInstallationPositionNmbr
- Item (SD)
Constraints: Nullable, Maximum length: 6
Original parameter name from the Odata EDM: EquipInstallationPositionNmbr
validityEndDate
- Valid To
Constraints: Not nullable, Precision: 0
Original parameter name from the Odata EDM: ValidityEndDate
equipmentInstallationDate
- Changed On
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: EquipmentInstallationDate
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.