6/15/2024

APIs for Maintenance Management

Generated on: 2024-06-15 11:21:47 GMT+0000

SAP S/4HANA | 2023 Latest

PUBLIC

Original content: https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/9a02a02d849d4b38a7320d94a71d2a22?locale=en-

US&state=PRODUCTION&version=2023.001

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the https://help.sap.com/docs/disclaimer.

This is custom documentation. For more information, please visit the SAP Help Portal 1
 6/15/2024

Maintenance Noti cation

Technical name: API_MAINTNOTIFICATION

The Maintenance Noti cation API is used to notify the maintenance department about an abnormal or exceptional situation in
technical objects in plant area. It records maintenance tasks completely and makes them available for analysis in the long term.
You can use them for preliminary planning and execution of tasks.

This service enables you to create, read, and update data related to maintenance noti cation. The data is provided in the
payload, in an API call. This service also supports deep entity for POST operation and BATCH processing.

The service supports the following operations for the maintenance noti cation.

Create maintenance noti cation data

Read maintenance noti cation data

Update maintenance noti cation data

Mass create, read and update of maintenance noti cation data

Set the maintenance noti cation to in process

Set the maintenance noti cation to completed

Attach documents. For more information, see Attachments.

BUS2038, the system creates a Generic Object Services (GOS) attachment. If you use the SAP business object type
PMQMEL, the system creates a Document Management System (DMS) attachment.

Additional Information
If the maintenance noti cation has a priority, the required start date, required end date, and the nal due date will be
calculated based on the priority and will overwrite the required start date, required end date, and the nal due date you
may have entered.

To view the calculation of dates based on the priority of a maintenance noti cation, go to the con guration activity If you
use the SAP business object type Plant Maintenance and Customer Service Maintenance and Service Processing
Maintenance and Service Noti cations Noti cation Processing Response Time Monitoring De ne Priorities
De ne Priorities for Each Priority Type .

If the maintenance noti cation is created for a technical object, the elds associated with the technical object are copied
into the maintenance noti cation from the technical object. To update any of the elds, you can update the maintenance
noti cation.

If you use the SAP business object typeThe service is based on OData protocol and can be consumed by external systems and
user interfaces.

This service is published on the SAP Business Accelerator Hub. For more information about APIs, see APIs on SAP Business
Accelerator Hub.

Service Structure
It is based on the OData protocol. It enables you to retrieve data in an API call. You can apply any of the lters provided or else
retrieve all existing data.

This is custom documentation. For more information, please visit the SAP Help Portal 2
 6/15/2024
The information is sent in the request as a payload. All information is utilized when processing data, including appropriate
checks for restricted values and authorizations. If any issues arise during an operation, the system displays error messages in
the response.

This service is built using the CDS views based on noti cation, noti cation item, noti cation item cause, noti cation item
activity and partner data via gateway service builder and SADL.

Message Header

The service message header contains information on the service, the involved sender and receiver as well as date and time.

Entity Description Link to Details

Maintenance Noti cation Allows you to create, read, and update a Maintenance Noti cation
(A_MaintenanceNotification noti cation.
)

Maintenance Noti cation Item Allows you to create, read, and update a Maintenance Noti cation Item
(A_MaintNotificationItem) noti cation item.

Maintenance Noti cation Item Activity Allows you to create, read, and update a Maintenance Noti cation Item Activity
(A_MaintNotifItemActivity) noti cation item activity.

Maintenance Noti cation Item Cause Data Allows you to create, read, and update Maintenance Noti cation Item Cause
(A_MaintNotifItemCause noti cation item cause.

Maintenance Noti cation Partner Allows you to create, read, and update a Maintenance Noti cation Partner
(A_MaintNotificationPartner) noti cation partner.

Associations and Cardinality

The following table lists the associations and cardinality for speci ed entities

Source Entity Target Entity Navigation Property Target Cardinality

A_MaintenanceNoti cation A_MaintNoti cationItem to_Item 0..*

A_MaintenanceNoti cation A_MaintNoti cationPartner to_Partner 0..*

A_MaintNoti cationItem A_MaintNotifItemActivity to_ItemActivity 0..*

A_MaintNoti cationItem A_MaintNotifItemCause to_ItemCause 0..*

Service Response

Entity Description

200 OK

201 Created

204 No content

400 Bad request

403 Forbidden

404 Not found

This is custom documentation. For more information, please visit the SAP Help Portal 3
 6/15/2024

Entity Description

500 Internal server error

Maintenance Noti cation

Technical name:A_MaintenanceNotification

Properties

Property Description Necessity

MaintenanceNoti cation Indicates the unique key that helps you Mandatory
identify the maintenance noti cation
number.

This eld is mandatory while reading and

updating a maintenance noti cation.

MaintNotifInternalID Indicates the internal object number of the Optional

maintenance noti cation.

Noti cationText Provides short description for the Optional

maintenance noti cation.

MaintPriority Indicates the importance of the processing Optional

the maintenance noti cation.

MaintPriorityDesc Describes the priority of the maintenance. Optional

Noti cationType Indicates the key that enables maintenance Optional

noti cations to be differentiated and
grouped according to noti cation category,
noti cation origin, and other criteria.

This eld is mandatory while creating a

noti cation.

NotifProcessingPhase Indicates the phase of maintenance Optional

noti cation processing. For example, ʻIn
Process’, ʻCompleted’, and so on.

NotifProcessingPhaseDesc Describes the maintenance noti cation Optional

processing phase.

ConcatenatedActiveSystStsName Indicates the status of the maintenance Optional

noti cation.

CreationDate Indicates the date on which the Optional

maintenance noti cation record was
created.

CreationTime Indicates the time at which the maintenance Optional

noti cation record was created.

LastChangeTime Indicates the time at which the maintenance Optional

noti cation record was changed.

This is custom documentation. For more information, please visit the SAP Help Portal 4
 6/15/2024

Property Description Necessity

LastChangeDate Indicates the date on which the Optional

maintenance noti cation record was
changed.

LastChangeDateTime Indicates the time in UTC Time Stamp Optional

(YYYYMMDDhhmmss).

ReportedByUser Indicates the name of person who reported Optional

the maintenance noti cation.

ReporterFullName Indicates the full name of the user who Optional

reported the maintenance noti cation.

PersonResponsible Provides name of the person who is Optional

responsible for the maintenance
noti cation.

PersonResponsibleName Provides name of the person responsible. Optional

MalfunctionEffect Indicates the effect of the technical object Optional

malfunction based on the operation.

MalfunctionEffectText Describes the effect. Optional

MalfunctionStartDate Indicates the date on which the malfunction Optional

started.

MalfunctionStartTime Indicates the time at which malfunction Optional

started.

MalfunctionEndDate Indicates the date on which the malfunction Optional

ended.

MalfunctionEndTime Indicates the time at which the malfunction Optional

ended.

MaintNoti cationCatalog Indicates the catalog type for the failure Optional
modes.

MaintNoti cationCodeGroup Indicates the mode of failure. Optional

MaintNoti cationCode Indicates the type of failure. Optional

CatalogPro le Catalog pro le is a combination of code Optional

groups from several catalogs.

Noti cationCreationDate Indicates the date on which the noti cation Optional
was created.

Noti cationCreationTime Time at which the noti cation was created. Optional

Noti cationTimeZone Time zone for noti cation. Optional

RequiredStartDate Indicates the date on which processing of Optional

the noti cation must start.

RequiredStartTime Indicates the time at which the processing Optional

of the noti cation must start.

RequiredEndDate Indicates the date on which the processing Optional

of the noti cation must be completed.

RequiredEndTime Indicates the time by which the processing Optional

of the noti cation must be completed.

This is custom documentation. For more information, please visit the SAP Help Portal 5
 6/15/2024

Property Description Necessity

LatestAcceptableCompletionDate Indicates the latest date by which a Optional

maintenance activity must be completed.

MaintenanceObjectIsDown Indicates if a machine has broken down. Optional

MaintNoti cationLongText Describes maintenance noti cation. Optional

MaintNotifLongTextForEdit Describes for maintenance noti cation. Optional

TechnicalObject Indicates the technical object for which a Optional

maintenance request is created. The
technical object can be either an equipment
or a functional location.

TechObjIsEquipOrFuncnlLoc Indicates the technical object type Optional

(equipment or functional location)

This information is required if you use a

technical object.

TechnicalObjectLabel Identi es the technical object. Optional

MaintenancePlanningPlant Identi es the plant in which maintenance Optional

tasks are planned and prepared

PlantName Name of the planning plant. Optional

MaintenancePlannerGroup Maintenance Planner Group. Identi es a Optional

group of employees responsible for
planning and processing maintenance tasks
in a plant.

MaintenancePlannerGroupName Indicates the name of the maintenance Optional

planner group.

PlantSection Indicates the plant section within a Optional

maintenance plant.

ABCIndicator Indicates the ABC indicator that is assigned Optional

to a technical object by the ABC analysis.
The ABC indicator classi es the criticality
of the technical object (high, medium or
low) for the production process. The
characteristics of the ABC indicator can be
used as a selection criterion in evaluations.

ABCIndicatorDesc Describes the ABC Indicator of the Optional

technical object.

SuperiorTechnicalObject Indicates the superior technical object of Optional

the affected technical object for which a
maintenance request is created.

SuperiorTechnicalObjectName Provides the name of the superior technical Optional

object.

SuperiorObjIsEquipOrFuncnlLoc Indicates the type of the superior technical Optional

object (equipment or functional location).

SuperiorTechnicalObjectLabel Identi es the superior technical object Optional

identi er.

This is custom documentation. For more information, please visit the SAP Help Portal 6
 6/15/2024

Property Description Necessity

ManufacturerPartTypeName Provides the model number of the Optional

manufacturer.

TechObjIsEquipOrFuncnlLocDesc Describes the technical object type. Optional

FunctionalLocation Label that uniquely identi es a functional Optional

location.

FunctionalLocationLabelName Functional location label. The label is used Optional

to identify a functional location from a
user's point of view

TechnicalObjectDescription Describes the technical object. Optional

AssetLocation Provides the location of the maintenance Optional

object within a maintenance plant.

LocationName Provides the location name of maintenance Optional

object.

BusinessArea Indicates the organizational unit within Optional

nancial accounting that represents a
separate area of operations or
responsibilities.

CompanyCode Indicates the organizational unit within Optional

nancial accounting for which a complete
self-contained set of accounts can be drawn
up for purposes of external reporting.

TechnicalObjectCategory Indicates the unique key for distinguishing Optional

technical objects according to their use

TechnicalObjectType Indicates the unique key that describes the Optional

type of the technical object.

MainWorkCenterPlant Indicates the maintenance plant associated Optional

with the main work center.

MainWorkCenterPlantName Provides the name of the maintenance plant Optional

associated with the main work center.

MainWorkCenter Indicates the main work center that is in Optional

charge when a maintenance task is
performed on the technical object.

MainWorkCenterText Provides name of the main work center. Optional

PlantName Provides name of the planning plant. Optional

MaintenancePlant Indicates the plant in which the technical Optional

objects are installed and maintained.

MaintenancePlantName Provides the name of the maintenance Optional

plant.

LocationDescription Indicates the actual location in which the Optional

technical object is currently available.

PlantSectionPersonRespName Indicates the group of employees Optional

responsible for a company area.

This is custom documentation. For more information, please visit the SAP Help Portal 7
 6/15/2024

Property Description Necessity

MaintenanceOrder Indicates the unique number for the Optional

maintenance order.

MaintenanceOrderType Indicates the type of the maintenance order. Optional

MaintenanceActivityType Describes the type of restoration action that Optional

is performed such as repair, replace,
overhaul, modify, and so on.

MaintObjDowntimeDurationUnit Indicates the unit of breakdown duration. Optional

MaintObjectDowntimeDuration Indicates the duration of the breakdown. Optional

MaintenancePlan Indicates a list of maintenance and Optional

inspection tasks to perform on maintenance
objects. This also includes the dates and
scope of such tasks.

MaintenanceItem Describes which preventive maintenance Optional

tasks should take place regularly at a
technical object or a group of technical
objects.

TaskListGroup Describe a sequence of individual Optional

maintenance activities which must be
repeatedly performed within a company. It
is identi ed by the unique combination of
task list type, task list group and group
counter.

TaskListGroupCounter Task list group counter. Optional

MaintenancePlanCallNumber Indicates the maintenance call object such Optional

as maintenance order, maintenance
noti cation, and so on, which is generated
when a maintenance plan is scheduled.

MaintenanceTaskListType Indicates the type of task lists. There are Optional

three types of task lists namely equipment
task list, functional location task list, and
general maintenance task list.

TaskList Indicates the unique combination of task Optional

list type, task list group and group counter.

Noti cationReferenceDate Indicates the reference date of noti cation Optional

completion. This date is entered by the user
while setting the maintenance noti cation to
ʻCompletion’.

Noti cationReferenceTime Indicates the reference time of noti cation Optional

completion. This date is entered by the user
while setting the maintenance noti cation to
ʻCompletion’.

Noti cationCompletionDate Indicates the date (system date) on which Optional

the maintenance noti cation is set to
ʻCompleted’. This eld is set in backend by
the system.

This is custom documentation. For more information, please visit the SAP Help Portal 8
 6/15/2024

Property Description Necessity

CompletionTime Indicates is the time (system time) on Optional

which the maintenance noti cation is set to
ʻCompleted’. This eld is set in backend by
the system.

AssetRoom Identi es speci c room for the asset. Optional

MaintNotifExtReferenceNumber Identi es the maintenance noti cation Optional

number created from any external system.

MaintNotifRejectionReasonCode Identi es the reason for maintenance Optional

request (noti cation) rejection or resent for
more information.

MaintNotifRejectionRsnCodeTxt Describes the reason code. Optional

MaintNotifProcessPhaseCode Indicates the value range using the Optional

description of the phase. The phase can be
any one between 01 (Initiation) to 09
(Completion).

MaintNotifProcessSubPhaseCode Indicates the value range using the Optional

description of the subphase.

EAMProcessPhaseCodeDesc Describes the maintenance process phase. Optional

EAMProcessSubPhaseCodeDesc Describes the maintenance process Optional

subphase.

CreationDateTime Indicates the date and time when the Optional. Read Only
maintenance noti cation was created.

MalfunctionStartDateTime Indicates the date and time (in UTC) when Optional. Read Only
the malfunction started.

MalfunctionEndDateTime Indicates the date and time (in UTC) when Optional. Read Only
the malfunction ended.

Noti cationCreationDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation was created.

MaintNotifRqdStartDateTime Indicates the date and time (in UTC) when Optional. Read Only
the processing of the noti cation needs to
start.

MaintNotifRqdEndDateTime Indicates the date and time (in UTC) by Optional. Read Only
which the processing of the noti cation
needs to be completed.

PreviousFinalDueDate Indicates the nal due date that existed Optional. Read Only
before the current nal due date.

 Note
To display more information about the properties on the SAP Business Accelerator Hub, open one of the entity's operations
and select Model.

Supported Operations
The following operations are supported:

This is custom documentation. For more information, please visit the SAP Help Portal 9
 6/15/2024
Read Maintenance Noti cation

Create Maintenance Noti cation

Update Maintenance Noti cation

Batch Request

Maintenance Noti cation Item

Technical name:A_MaintNotificationItem

Properties

Property Description Necessity

MaintenanceNoti cation Indicates the unique key that helps you Mandatory
identify the maintenance noti cation
number.

This information is mandatory while

creating and updating maintenance
noti cation item.

MaintenanceNoti cationItem Indicates the unique key that identi es Mandatory

maintenance noti cation item number.

This information is mandatory while

updating maintenance noti cation item.

MaintNotifItemText Indicates the maintenance noti cation item Optional

text.

MaintNotifDamageCodeGroup Indicates the maintenance noti cation Optional

damage code group

MaintNotifDamageCodeGroupName Indicates maintenance noti cation damage Optional

code group text

MaintNoti cationDamageCode Indicates maintenance noti cation damage Optional

code

MaintNotifDamageCodeName Indicates maintenance noti cation damage Optional

code text

MaintNotifObjPrtCodeGroup Indicates maintenance noti cation object Optional

part code group

MaintNotifObjPrtCodeGroupName Indicates maintenance noti cation object Optional

part code group text

MaintNotifObjPrtCode Indicates maintenance noti cation object Optional

part code

MaintNotifObjPrtCodeName Indicates maintenance noti cation object Optional

part code text

IsDeleted Indicates if the item is deleted. Optional

This is custom documentation. For more information, please visit the SAP Help Portal 10
 6/15/2024

Property Description Necessity

MaintNotifItemCreationDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation item was
created.

MaintNotifItemChangedDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation item was
updated.

 Note
To display more information about the properties on the SAP Business Accelerator Hub, open one of the entity's operations
and select Model.

Supported Operations
The following operations are supported:

Read Noti cation Item

Create Noti cation Item

Update Noti cation Item

Maintenance Noti cation Item Activity

Technical name:A_MaintNotifItemActivity

Properties

Property Description Necessity

MaintNoti cationActivity Indicates the unique key that helps you Mandatory
identify the maintenance noti cation
activity number.

This information is mandatory while

updating maintenance noti cation item
activity.

MaintenanceNoti cation Indicates the unique key that identi es Mandatory

maintenance noti cation number.

This information is mandatory while

creating and updating maintenance
noti cation item activity.

MaintenanceNoti cationItem Indicates the unique key which identi es Mandatory

maintenance noti cation item number

This information is mandatory while

creating and updating maintenance
noti cation item activity.

MaintNotifActivitySortNumber Indicates the maintenance noti cation Optional

activity sort number.

This is custom documentation. For more information, please visit the SAP Help Portal 11
 6/15/2024

Property Description Necessity

MaintNotifActyTxt Indicates the maintenance noti cation One of these properties must be available:
activity text
MaintNotifActyTxt

MaintNotifActivityCodeGroup

NotifActivityCodeGroupText

MaintNotifActivityCodeGroup Indicates maintenance noti cation activity One of these properties must be available:
code group
MaintNotifActyTxt

MaintNotifActivityCodeGroup

NotifActivityCodeGroupText

NotifActivityCodeGroupText Indicates maintenance noti cation activity One of these properties must be available:
code group text
MaintNotifActyTxt

MaintNotifActivityCodeGroup

NotifActivityCodeGroupText

MaintNoti cationActivityCode Indicates maintenance noti cation activity Optional

code

NotifActivityCodeText Indicates maintenance noti cation activity Optional

code text

PlannedStartDate Indicates planned start date of an activity Optional

PlannedStartTime Indicates planned start time of an activity Optional

PlannedEndDate Indicates planned end date of an activity Optional

PlannedEndTime Indicates planned end time of an activity Optional

IsDeleted Indicates if the item activity is deleted. Optional

MaintNotifItmActyStrtDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation activity
started.

MaintNotifItemActyEndDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation activity ended.

MaintNotifItemActyCrtnDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation activity was
created.

MaintNotifItemActyChgdDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation activity was
changed.

 Note
To display more information about the properties on the SAP Business Accelerator Hub, open one of the entity's operations
and select Model.

Supported Operations
This is custom documentation. For more information, please visit the SAP Help Portal 12
 6/15/2024
The following operations are supported:

Read Noti cation Item Activity

Create Noti cation Item Activity

Update Noti cation Item Activity

Maintenance Noti cation Item Cause

Technical name:A_MaintNotifItemCause

Properties

Property Description Necessity

MaintenanceNoti cation Indicates the unique key that helps you Mandatory
identify the maintenance noti cation
number.

This information is mandatory while

creating and updating the maintenance
noti cation item cause.

MaintenanceNoti cationItem Indicates the unique key that identi es Mandatory

maintenance noti cation item number.

This information is mandatory while

creating and updating the maintenance
noti cation item cause.

MaintenanceNoti cationCause Indicates the unique key which identi es Mandatory

maintenance noti cation item cause
number

This information is mandatory while

updating the maintenance noti cation item
cause.

MaintNotifCauseText Indicates the maintenance noti cation Optional

cause text.

MaintNotifCauseCodeGroup Indicates the maintenance noti cation Optional

cause code group

MaintNotifCauseCodeGroupName Indicates maintenance noti cation cause Optional

code group text

MaintNoti cationCauseCode Indicates maintenance noti cation cause Optional

code

MaintNoti cationCauseCodeName Indicates maintenance noti cation cause Optional

code text

MaintNoti cationRootCause Indicates maintenance noti cation root Optional

cause

MaintNoti cationRootCauseText Indicates maintenance noti cation root Optional

cause text

IsDeleted Indicates if the item cause is deleted. Optional

This is custom documentation. For more information, please visit the SAP Help Portal 13
 6/15/2024

Property Description Necessity

MaintNotifItmCauseCrtnDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation item cause
was created.

MaintNotifItmCauseChgdDateTime Indicates the date and time (in UTC) when Optional. Read Only
the maintenance noti cation item cause
was changed.

 Note
To display more information about the properties on the SAP Business Accelerator Hub, open one of the entity's operations
and select Model.

Supported Operations
The following operations are supported:

Read Noti cation Item Cause

Create Noti cation Item Cause

Update Noti cation Item Cause

Maintenance Noti cation Partner

Technical name:A_MaintNotificationPartner

Properties

Property Description Necessity

MaintenanceNoti cation Indicates the unique key that helps you Mandatory
identify the maintenance noti cation
number.

This information is mandatory while

creating and updating the maintenance
noti cation item cause.

PartnerFunction Indicates the unique key that identi es the Mandatory

partner function.

This information is mandatory while

creating and updating the maintenance
noti cation item cause.

Noti cationPartnerObjectNmbr Indicates the unique key which identi es Mandatory

partner object number of noti cation.

This information is mandatory while

updating the maintenance noti cation item
cause.

Partner Indicates the partner who performs an Optional

operation.

This is custom documentation. For more information, please visit the SAP Help Portal 14
 6/15/2024

 Note
To display more information about the properties on the SAP Business Accelerator Hub, open one of the entity's operations
and select Model.

Supported Operations
The following operations are supported:

Read Noti cation Partner

Create Noti cation Partner

Update Noti cation Partner

Operations for Maintenance Noti cations

The API_MAINTNOTIFICATION API offers these operations:

Operation HTTP Sample URL

Method

Read GET GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation

Maintenance
GET - <host>
Noti cation
/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation(MaintenanceNoti cation='10101798’)

Create POST POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation

Maintenance
Noti cation

Update PATCH PATCH - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation

Maintenance
Noti cation

Batch POST POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/$batch

Request

Read GET GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationItem

Noti cation
GET - <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationItem?
Item
$ lter=MaintenanceNoti cation eq'10001316'

GET - <host>
/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationItem(MaintenanceNoti cation='1000131
MaintenanceNoti cationItem='1')

Create POST POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationItem

Noti cation
Item

Update PATCH PATCH – <host> /sap/opu/odata/SAP/API_MAINTNOTIFICATION/MaintenanceNoti cationItem

Noti cation (MaintenanceNoti cation='10001690',MaintenanceNoti cationItem='1')
Item

This is custom documentation. For more information, please visit the SAP Help Portal 15
 6/15/2024

Operation HTTP Sample URL

Method

Read GET GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemActivity

Noti cation
GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemActivity?
Item Activity
$ lter=MaintenanceNoti cation eq '10000060'

GET - <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemActivity

(MaintenanceNoti cation='10001240',MaintenanceNoti cationItem='1',MaintNoti cationActivity='1')

Create POST POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemActivity

Noti cation
Item Activity

Update PATCH PATCH - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemActivity

Noti cation (MaintenanceNoti cation='10001240',MaintenanceNoti cationItem='1',MaintNoti cationActivity='1')
Item Activity

Read GET GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemCause

Noti cation
GET - <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemCause?
Item Cause
$ lter=MaintenanceNoti cation eq'10001316' GET - <host>
/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemCause(MaintenanceNoti cation='10001316
MaintenanceNoti cationItem='1',MaintenanceNoti cationCause='1')

Create POST POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemCause

Noti cation
Item Cause

Update PATCH PATCH – <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemCause

Noti cation (MaintenanceNoti cation='10001690',MaintenanceNoti cationItem='2',MaintenanceNoti cationCause='1')
Item Cause

Read GET GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner

Noti cation
GET -<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner?
Partner
$ lter=MaintenanceNoti cation eq '10000060'

GET - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner

(MaintenanceNoti cation='10001678',PartnerFunction='AB',Noti cationPartnerObjectNmbr='0001')

Create POST POST - <HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner

Noti cation
Partner

Update PATCH PATCH - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner

Noti cation (MaintenanceNoti cation='10001678',PartnerFunction='AB',Noti cationPartnerObjectNmbr='0001')
Partner

ETags
The service uses entity tags (ETags) for optimistic concurrency control. That is, if a client requests a modi cation of a resource
on the backend server, the ETags of the resource on the client and on the backend server are compared to determine whether
any changes have been made to the resource on the backend server. For this service, the If-Match header must be set for all
change operations.

If you are not processing the latest version of a condition record, the system raises an error that stops you from saving your
changes. Alternatively, you can also use * in If-Match that would bypass etag check.

The Etag handling feature is implemented on the A_MaintenanceNotification entity and eld LastChangeDateTime.

This is custom documentation. For more information, please visit the SAP Help Portal 16
 6/15/2024
PATCH requires etag to be speci ed.

Proceed as follows:

In header of the update request, a header element If-Match needs to be speci ed. The value can be obtained through a reading
request on the entity that you are updating. The response contains a header eld called etag, the value of which should be used
as the value of If-Match.

Read Maintenance Noti cation

With this operation, you can read maintenance noti cation.

Examples
Request

 Sample Code
<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10101798')

Response

{
"d" : {
"__metadata" : {
"id" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10101798')",
"uri" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10101798')",
"type" : "cds_api_maintnotification.MaintenanceNotificationType",
"etag" : "W/\"'SADL-020200916101921C~20200916101921'\""
},
"MaintenanceNotification" : "10101798",
"MaintNotifInternalID" : "QM000010101798",
"NotificationText" : "This is a sample Notification",
"MaintPriority" : "",
"NotificationType" : "Y1",
"NotifProcessingPhase" : "4",
"NotifProcessingPhaseDesc" : "Completed",
"MaintPriorityDesc" : "",
"CreationDate" : "\/Date(1599782400000)\/",
"LastChangeTime" : "PT12H19M19S",
"LastChangeDate" : "\/Date(1600214400000)\/",
"LastChangeDateTime" : "\/Date(1600251561000+0000)\/",
"CreationTime" : "PT08H04M48S",
"ReportedByUser" : "Dummy",
"ReporterFullName" : " Dummy ",
"PersonResponsible" : "",
"MalfunctionEffect" : "",
"MalfunctionEffectText" : "",
"MalfunctionStartDate" : "\/Date(1599782400000)\/",
"MalfunctionStartTime" : "PT07H04M48S",
"MalfunctionEndDate" : null,
"MalfunctionEndTime" : "PT00H00M00S",
"MaintNotificationCatalog" : "D",
"MaintNotificationCode" : "",
"MaintNotificationCodeGroup" : "",
"CatalogProfile" : "YB-PM0001",
"NotificationCreationDate" : "\/Date(1599782400000)\/",
"NotificationCreationTime" : "PT07H04M48S",
"NotificationTimeZone" : "UTC+1",
"RequiredStartDate" : "\/Date(1599782400000)\/",
"RequiredStartTime" : "PT07H04M48S",
"RequiredEndDate" : null,
"RequiredEndTime" : "PT00H00M00S",

This is custom documentation. For more information, please visit the SAP Help Portal 17
 6/15/2024
"LatestAcceptableCompletionDate" : null,
"MaintenanceObjectIsDown" : false,
"MaintNotificationLongText" : "16.09.2020 12:19:19 CET (Dummy) rejecting a notification is toug
"MaintNotifLongTextForEdit" : "",
"TechnicalObject" : "TEST",
"TechObjIsEquipOrFuncnlLoc" : "EAMS_EQUI",
"TechnicalObjectLabel" : "TEST",
"MaintenancePlanningPlant" : "",
"MaintenancePlannerGroup" : "",
"PlantSection" : "",
"ABCIndicator" : "",
"SuperiorTechnicalObject" : "",
"SuperiorTechnicalObjectName" : "",
"SuperiorObjIsEquipOrFuncnlLoc" : "",
"SuperiorTechnicalObjectLabel" : "",
"ManufacturerPartTypeName" : "",
"TechObjIsEquipOrFuncnlLocDesc" : "Equipment",
"FunctionalLocation" : "",
"FunctionalLocationLabelName" : "",
"TechnicalObjectDescription" : "test customer equipment",
"AssetLocation" : "",
"LocationName" : "",
"BusinessArea" : "",
"CompanyCode" : "",
"TechnicalObjectCategory" : "S",
"TechnicalObjectType" : "",
"MainWorkCenterPlant" : "",
"MainWorkCenter" : "",
"PlantName" : "",
"MaintenancePlannerGroupName" : "",
"MaintenancePlant" : "",
"LocationDescription" : "",
"MainWorkCenterText" : "",
"MainWorkCenterPlantName" : "",
"MaintenancePlantName" : "",
"PlantSectionPersonRespName" : "",
"ABCIndicatorDesc" : "",
"PersonResponsibleName" : "",
"MaintenanceOrder" : "",
"MaintenanceOrderType" : "",
"ConcatenatedActiveSystStsName" : "APRF NOCO",
"MaintenanceActivityType" : "",
"MaintObjDowntimeDurationUnit" : "H",
"MaintObjectDowntimeDuration" : "0",
"MaintenancePlan" : "",
"MaintenanceItem" : "",
"TaskListGroup" : "",
"TaskListGroupCounter" : "",
"MaintenancePlanCallNumber" : 0,
"MaintenanceTaskListType" : "",
"TaskList" : "",
"NotificationReferenceDate" : "\/Date(1600214400000)\/",
"NotificationReferenceTime" : "PT12H19M19S",
"NotificationCompletionDate" : "\/Date(1600214400000)\/",
"CompletionTime" : "PT11H19M19S",
"AssetRoom" : "",
"MaintNotifExtReferenceNumber" : "",
"MaintNotifRejectionReasonCode" : "Y02",
"MaintNotifRejectionRsnCodeTxt" : "More Information Needed",
"CreationDateTime": "/Date(1492098664000)/",
"MalfunctionStartDateTime": "/Date(1492098664000)/",
"MalfunctionEndDateTime": "/Date(1492098664000)/",
"NotificationCreationDateTime": "/Date(1492098664000)/",
"MaintNotifRqdStartDateTime": "/Date(1492098664000)/",
"MaintNotifRqdEndDateTime": "/Date(1492098664000)/",
"PreviousFinalDueDate": "/Date(1492041600000)/",
"to_Item" : {
"__deferred" : {
"uri" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10101798')
}
},
"to_Partner" : {
"__deferred" : {
"uri" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10101798')

This is custom documentation. For more information, please visit the SAP Help Portal 18
 6/15/2024
}
}
}
}

Create Maintenance Noti cation

With this operation, you can create the maintenance noti cation.

Prerequisites
For all POST operations, before you can send the noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token. For example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification X-CSRF-Token: fetch

The response header contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual noti cation request, you have to add this token to the header (apart from the other headers). See
also the following example in the section Request.

Examples

Request

 Sample Code
POST <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification X-CSRF-Token: 4kY1WdN

{
"NotificationText": "Sample Notification",
"MaintPriority": "2",
"NotificationType": "Y1",
"ReportedByUser": "Dummy",
"PersonResponsible": "113",
"MalfunctionEffect": "3",
"MalfunctionStartDate": "/Date(1492041600000)/",
"MalfunctionStartTime": "PT15H51M04S",
"MalfunctionEndDate": "/Date(1492041600000)/",
"MalfunctionEndTime": "PT15H51M04S",
"MaintNotificationCode": "1",
"MaintNotificationCodeGroup": "ZTESTING",
"NotificationCreationDate": "/Date(1492041600000)/",
"NotificationCreationTime": "PT15H51M04S",
"RequiredStartDate": "/Date(1492041600000)/",
"RequiredStartTime": "PT15H51M04S",
"RequiredEndDate": "/Date(1492041600000)/",
"RequiredEndTime": "PT15H51M04S",
"LatestAcceptableCompletionDate": "/Date(1492041600000)/",
"MaintenanceObjectIsDown": true,
"MaintNotifLongTextForEdit": "SampleLongText",
"TechnicalObject": "TEST",
"TechObjIsEquipOrFuncnlLoc": "EAMS_EQUI",
"MaintenancePlanningPlant": "0001",
"MainWorkCenterPlant": "0001",
"MainWorkCenter": "ABC",
"MaintenancePlant": "0001",
"LocationDescription": "CurrentLocation",
This is custom documentation. For more information, please visit the SAP Help Portal 19
 6/15/2024
"MaintenanceActivityType": "001",
"MaintObjDowntimeDurationUnit": "HR",
"MaintObjectDowntimeDuration": "8",
"NotificationReferenceDate": "/Date(1492041600000)/",
"NotificationReferenceTime": "PT15H51M04S",
"MaintNotifExtReferenceNumber": "1111111"
}

Response

{
"d" : {
"__metadata" : {
"id" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102463')",
"uri" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102463')",
"type" : "cds_api_maintnotification.MaintenanceNotificationType",
"etag" : "W/\"'SADL-020200925111547C~20200925111547'\""
},
"MaintenanceNotification" : "10102463",
"MaintNotifInternalID" : "QM000010102463",
"NotificationText" : "Sample Notification",
"MaintPriority" : "2",
"NotificationType" : "Y1",
"NotifProcessingPhase" : "1",
"NotifProcessingPhaseDesc" : "Outstanding",
"MaintPriorityDesc" : "2-High",
"CreationDate" : "\/Date(1600992000000)\/",
"LastChangeTime" : "PT13H15M46S",
"LastChangeDate" : "\/Date(1600992000000)\/",
"LastChangeDateTime" : "\/Date(1601032547000+0000)\/",
"CreationTime" : "PT13H15M46S",
"ReportedByUser" : "DUMMY",
"ReporterFullName" : "DUMMY",
"PersonResponsible" : "113",
"MalfunctionEffect" : "3",
"MalfunctionEffectText" : "Production breakdown",
"MalfunctionStartDate" : "\/Date(1492041600000)\/",
"MalfunctionStartTime" : "PT15H51M04S",
"MalfunctionEndDate" : "\/Date(1492041600000)\/",
"MalfunctionEndTime" : "PT15H51M04S",
"MaintNotificationCatalog" : "D",
"MaintNotificationCode" : "1",
"MaintNotificationCodeGroup" : "ZTESTING",
"CatalogProfile" : "YB-PM0001",
"NotificationCreationDate" : "\/Date(1492041600000)\/",
"NotificationCreationTime" : "PT15H51M04S",
"NotificationTimeZone" : "UTC+1",
"RequiredStartDate" : "\/Date(1492041600000)\/",
"RequiredStartTime" : "PT15H51M04S",
"RequiredEndDate" : "\/Date(1492041600000)\/",
"RequiredEndTime" : "PT15H51M04S",
"LatestAcceptableCompletionDate" : "\/Date(1492041600000)\/",
"MaintenanceObjectIsDown" : true,
"MaintNotificationLongText" : "",
"MaintNotifLongTextForEdit" : "",
"TechnicalObject" : "TEST",
"TechObjIsEquipOrFuncnlLoc" : "EAMS_EQUI",
"TechnicalObjectLabel" : "TEST",
"MaintenancePlanningPlant" : "0001",
"MaintenancePlannerGroup" : "",
"PlantSection" : "",
"ABCIndicator" : "",
"SuperiorTechnicalObject" : "",
"SuperiorTechnicalObjectName" : "",
"SuperiorObjIsEquipOrFuncnlLoc" : "",
"SuperiorTechnicalObjectLabel" : "",
"ManufacturerPartTypeName" : "",
"TechObjIsEquipOrFuncnlLocDesc" : "Equipment",
"FunctionalLocation" : "",
"FunctionalLocationLabelName" : "",
"TechnicalObjectDescription" : "test customer equipment",
"AssetLocation" : "",

This is custom documentation. For more information, please visit the SAP Help Portal 20
 6/15/2024
"LocationName" : "",
"BusinessArea" : "",
"CompanyCode" : "0001",
"TechnicalObjectCategory" : "S",
"TechnicalObjectType" : "",
"MainWorkCenterPlant" : "0001",
"MainWorkCenter" : "ABC",
"PlantName" : "Walldorf Plant",
"MaintenancePlannerGroupName" : "",
"MaintenancePlant" : "0001",
"LocationDescription" : "CurrentLocation",
"MainWorkCenterText" : "WORK CENTER FOR UNIT TEST",
"MainWorkCenterPlantName" : "Walldorf Plant",
"MaintenancePlantName" : "Walldorf Plant",
"PlantSectionPersonRespName" : "",
"ABCIndicatorDesc" : "",
"PersonResponsibleName" : "dummy",
"MaintenanceOrder" : "",
"MaintenanceOrderType" : "",
"ConcatenatedActiveSystStsName" : "APRQ OSNO",
"MaintenanceActivityType" : "001",
"MaintObjDowntimeDurationUnit" : "HR",
"MaintObjectDowntimeDuration" : "2.88E4",
"MaintenancePlan" : "",
"MaintenanceItem" : "",
"TaskListGroup" : "",
"TaskListGroupCounter" : "",
"MaintenancePlanCallNumber" : 0,
"MaintenanceTaskListType" : "",
"TaskList" : "",
"NotificationReferenceDate" : "\/Date(1600992000000)\/",
"NotificationReferenceTime" : "PT13H15M46S",
"NotificationCompletionDate" : null,
"CompletionTime" : "PT00H00M00S",
"AssetRoom" : "",
"MaintNotifExtReferenceNumber" : "1111111",
"MaintNotifRejectionReasonCode" : "",
"MaintNotifRejectionRsnCodeTxt" : "",
"to_Item" : {
"__deferred" : {
"uri" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102463')
}
},
"to_Partner" : {
"__deferred" : {
"uri" : "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102463')
}
}
}
}

Update Maintenance Noti cation

With this operation, you can update a maintenance noti cation.

Prerequisites
As for all POST operations, before you can send the Noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token, for example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

This is custom documentation. For more information, please visit the SAP Help Portal 21
 6/15/2024
When you send the actual Noti cation request, you then have to add this token to the header (apart from the other headers),
see also the following example under Request.

Examples

Request

 Sample Code
PATCH <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification(‘10102553’) X-CSRF-T

 Sample Code
{
"MaintPriority": "1"
}

Response

 Sample Code
sap-message : {"code":"EAMS_BO/029","message":"Notification 10102553 saved","target":"","severity

Batch Request
With this operation, you can perform batch requests.

Prerequisites
As for all POST operations, before you can send the Noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token, for example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual Noti cation request, you then have to add this token to the header (apart from the other headers),
see also the following example under Request.

Examples
Request

 Sample Code
PATCH <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/$batch X-CSRF-Token: 4kY1WdNn18CS9xfkFx7EbA=

Request Body

This is custom documentation. For more information, please visit the SAP Help Portal 22
 6/15/2024

 Sample Code
--batch
Content-Type: application/http
Content-Transfer-Encoding: binary

GET MaintenanceNotification?$filter=MaintenanceNotification%20eq%20%2710002325%27 HTTP/1.1

Content-Type: application/json
Accept: application/json

--batch
Content-Type: multipart/mixed; boundary=changeset_77162fcd-b8da-41ac-a9f8-9357efbbd621

--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd621
Content-Type: application/http
Content-Transfer-Encoding: binary

POST MaintenanceNotification HTTP/1.1

Content-Type: application/json
Accept: application/json

{
"NotificationText": "Test Notification 1",
"NotificationType": "M1"
}

--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd621--

--batch
Content-Type: multipart/mixed; boundary=changeset_77162fcd-b8da-41ac-a9f8-9357efbbd621

--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd621
Content-Type: application/http
Content-Transfer-Encoding: binary

POST MaintenanceNotification HTTP/1.1

Content-Type: application/json
Accept: application/json

{
"NotificationText": "Test Notification 2",
"NotificationType": "M1"
}

--changeset_77162fcd-b8da-41ac-a9f8-9357efbbd621--
--batch—

Response

--93A9530A4FDB16E620AD529CC4E28EF80
Content-Type: application/http
Content-Length: 3641
content-transfer-encoding: binary

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 3434
sap-metadata-last-modified: Fri, 25 Sep 2020 10:42:18 GMT
cache-control: no-store, no-cache
dataserviceversion: 2.0
{
"d": {
"results": [
{
"__metadata": {

This is custom documentation. For more information, please visit the SAP Help Portal 23
 6/15/2024
"id": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002325')
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002325'
"type": "cds_api_maintnotification.MaintenanceNotificationType",
"etag": "W/\"'SADL-000000000000000C~0'\""
},
"MaintenanceNotification": "10002325",
"MaintNotifInternalID": "QM000010002325",
"NotificationText": "UnitTest Notification",
"MaintPriority": "",
"NotificationType": "M1",
"NotifProcessingPhase": "5",
"NotifProcessingPhaseDesc": "Deletion Flag",
"MaintPriorityDesc": "",
"CreationDate": "\/Date(1437609600000)\/",
"LastChangeTime": "PT17H16M23S",
"LastChangeDate": "\/Date(1441929600000)\/",
"LastChangeDateTime": null,
"CreationTime": "PT15H10M01S",
"ReportedByUser": "",
"ReporterFullName": "",
"PersonResponsible": "",
"MalfunctionEffect": "",
"MalfunctionEffectText": "",
"MalfunctionStartDate": null,
"MalfunctionStartTime": "PT00H00M00S",
"MalfunctionEndDate": null,
"MalfunctionEndTime": "PT00H00M00S",
"MaintNotificationCatalog": "D",
"MaintNotificationCode": "",
"MaintNotificationCodeGroup": "",
"CatalogProfile": "000000001",
"NotificationCreationDate": "\/Date(1437609600000)\/",
"NotificationCreationTime": "PT15H10M01S",
"NotificationTimeZone": "CET",
"RequiredStartDate": "\/Date(1437609600000)\/",
"RequiredStartTime": "PT15H10M01S",
"RequiredEndDate": "\/Date(1440201600000)\/",
"RequiredEndTime": "PT23H59M59S",
"LatestAcceptableCompletionDate": null,
"MaintenanceObjectIsDown": false,
"MaintNotificationLongText": "",
"MaintNotifLongTextForEdit": "",
"TechnicalObject": "",
"TechObjIsEquipOrFuncnlLoc": "",
"TechnicalObjectLabel": "",
"MaintenancePlanningPlant": "",
"MaintenancePlannerGroup": "",
"PlantSection": "",
"ABCIndicator": "",
"SuperiorTechnicalObject": "",
"SuperiorTechnicalObjectName": "",
"SuperiorObjIsEquipOrFuncnlLoc": "",
"SuperiorTechnicalObjectLabel": "",
"ManufacturerPartTypeName": "",
"TechObjIsEquipOrFuncnlLocDesc": "",
"FunctionalLocation": "",
"FunctionalLocationLabelName": "",
"TechnicalObjectDescription": "",
"AssetLocation": "",
"LocationName": "",
"BusinessArea": "",
"CompanyCode": "",
"TechnicalObjectCategory": "",
"TechnicalObjectType": "",
"MainWorkCenterPlant": "",
"MainWorkCenter": "",
"PlantName": "",
"MaintenancePlannerGroupName": "",
"MaintenancePlant": "",
"LocationDescription": "",
"MainWorkCenterText": "",
"MainWorkCenterPlantName": "",
"MaintenancePlantName": "",
"PlantSectionPersonRespName": "",

This is custom documentation. For more information, please visit the SAP Help Portal 24
 6/15/2024
"ABCIndicatorDesc": "",
"PersonResponsibleName": "",
"MaintenanceOrder": "4000659",
"MaintenanceOrderType": "PM01",
"ConcatenatedActiveSystStsName": "ATCO DLFL NOCO ORAS",
"MaintenanceActivityType": "",
"MaintObjDowntimeDurationUnit": "H",
"MaintObjectDowntimeDuration": "0",
"MaintenancePlan": "",
"MaintenanceItem": "",
"TaskListGroup": "",
"TaskListGroupCounter": "",
"MaintenancePlanCallNumber": 0,
"MaintenanceTaskListType": "",
"TaskList": "",
"NotificationReferenceDate": "\/Date(1437609600000)\/",
"NotificationReferenceTime": "PT15H10M03S",
"NotificationCompletionDate": "\/Date(1437609600000)\/",
"CompletionTime": "PT15H10M03S",
"AssetRoom": "",
"MaintNotifExtReferenceNumber": "",
"MaintNotifRejectionReasonCode": "",
"MaintNotifRejectionRsnCodeTxt": "",
"to_Item": {
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('1000232
}
},
"to_Partner": {
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('1000232
}
}
}
]
}
}

--93A9530A4FDB16E620AD529CC4E28EF80
Content-Type: multipart/mixed; boundary=93A9530A4FDB16E620AD529CC4E28EF81
Content-Length: 4014

--93A9530A4FDB16E620AD529CC4E28EF81
Content-Type: application/http
Content-Length: 3845
content-transfer-encoding: binary

HTTP/1.1 201 Created

Content-Type: application/json
Content-Length: 3428
location: https://ldai2er9.wdf.sap.corp:44300/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNo
dataserviceversion: 2.0
sap-message: {"code":"EAMS_BO/029","message":"Notification 10102552 saved","target":"","severity":"
etag: W/"'SADL-020200925200524C~20200925200524'"

{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102552')",
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102552')",
"type": "cds_api_maintnotification.MaintenanceNotificationType",
"etag": "W/\"'SADL-020200925200524C~20200925200524'\""
},
"MaintenanceNotification": "10102552",
"MaintNotifInternalID": "QM000010102552",
"NotificationText": "Test Notification 1",
"MaintPriority": "",
"NotificationType": "M1",
"NotifProcessingPhase": "1",
"NotifProcessingPhaseDesc": "Outstanding",
"MaintPriorityDesc": "",
"CreationDate": "\/Date(1600992000000)\/",

This is custom documentation. For more information, please visit the SAP Help Portal 25
 6/15/2024
"LastChangeTime": "PT22H05M20S",
"LastChangeDate": "\/Date(1600992000000)\/",
"LastChangeDateTime": "\/Date(1601064324000+0000)\/",
"CreationTime": "PT22H05M20S",
"ReportedByUser": "Dummy",
"ReporterFullName": "Dummy",
"PersonResponsible": "",
"MalfunctionEffect": "",
"MalfunctionEffectText": "",
"MalfunctionStartDate": "\/Date(1600992000000)\/",
"MalfunctionStartTime": "PT21H05M20S",
"MalfunctionEndDate": null,
"MalfunctionEndTime": "PT00H00M00S",
"MaintNotificationCatalog": "D",
"MaintNotificationCode": "",
"MaintNotificationCodeGroup": "",
"CatalogProfile": "000000001",
"NotificationCreationDate": "\/Date(1600992000000)\/",
"NotificationCreationTime": "PT21H05M20S",
"NotificationTimeZone": "UTC+1",
"RequiredStartDate": "\/Date(1600992000000)\/",
"RequiredStartTime": "PT21H05M20S",
"RequiredEndDate": null,
"RequiredEndTime": "PT00H00M00S",
"LatestAcceptableCompletionDate": null,
"MaintenanceObjectIsDown": false,
"MaintNotificationLongText": "",
"MaintNotifLongTextForEdit": "",
"TechnicalObject": "",
"TechObjIsEquipOrFuncnlLoc": "",
"TechnicalObjectLabel": "",
"MaintenancePlanningPlant": "",
"MaintenancePlannerGroup": "",
"PlantSection": "",
"ABCIndicator": "",
"SuperiorTechnicalObject": "",
"SuperiorTechnicalObjectName": "",
"SuperiorObjIsEquipOrFuncnlLoc": "",
"SuperiorTechnicalObjectLabel": "",
"ManufacturerPartTypeName": "",
"TechObjIsEquipOrFuncnlLocDesc": "",
"FunctionalLocation": "",
"FunctionalLocationLabelName": "",
"TechnicalObjectDescription": "",
"AssetLocation": "",
"LocationName": "",
"BusinessArea": "",
"CompanyCode": "",
"TechnicalObjectCategory": "",
"TechnicalObjectType": "",
"MainWorkCenterPlant": "",
"MainWorkCenter": "",
"PlantName": "",
"MaintenancePlannerGroupName": "",
"MaintenancePlant": "",
"LocationDescription": "",
"MainWorkCenterText": "",
"MainWorkCenterPlantName": "",
"MaintenancePlantName": "",
"PlantSectionPersonRespName": "",
"ABCIndicatorDesc": "",
"PersonResponsibleName": "",
"MaintenanceOrder": "",
"MaintenanceOrderType": "",
"ConcatenatedActiveSystStsName": "OSNO",
"MaintenanceActivityType": "",
"MaintObjDowntimeDurationUnit": "H",
"MaintObjectDowntimeDuration": "0",
"MaintenancePlan": "",
"MaintenanceItem": "",
"TaskListGroup": "",
"TaskListGroupCounter": "",
"MaintenancePlanCallNumber": 0,
"MaintenanceTaskListType": "",

This is custom documentation. For more information, please visit the SAP Help Portal 26
 6/15/2024
"TaskList": "",
"NotificationReferenceDate": "\/Date(1600992000000)\/",
"NotificationReferenceTime": "PT22H05M20S",
"NotificationCompletionDate": null,
"CompletionTime": "PT00H00M00S",
"AssetRoom": "",
"MaintNotifExtReferenceNumber": "",
"MaintNotifRejectionReasonCode": "",
"MaintNotifRejectionRsnCodeTxt": "",
"to_Item": {
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102552')/
}
},
"to_Partner": {
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102552')/
}
}
}
}
--93A9530A4FDB16E620AD529CC4E28EF81--

--93A9530A4FDB16E620AD529CC4E28EF80
Content-Type: multipart/mixed; boundary=93A9530A4FDB16E620AD529CC4E28EF81
Content-Length: 4014

--93A9530A4FDB16E620AD529CC4E28EF81
Content-Type: application/http
Content-Length: 3845
content-transfer-encoding: binary

HTTP/1.1 201 Created

Content-Type: application/json
Content-Length: 3428
location: https://ldai2er9.wdf.sap.corp:44300/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNo
dataserviceversion: 2.0
sap-message: {"code":"EAMS_BO/029","message":"Notification 10102553 saved","target":"","severity":"
etag: W/"'SADL-020200925200529C~20200925200529'"

{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102553')",
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102553')",
"type": "cds_api_maintnotification.MaintenanceNotificationType",
"etag": "W/\"'SADL-020200925200529C~20200925200529'\""
},
"MaintenanceNotification": "10102553",
"MaintNotifInternalID": "QM000010102553",
"NotificationText": "Test Notification 2",
"MaintPriority": "",
"NotificationType": "M1",
"NotifProcessingPhase": "1",
"NotifProcessingPhaseDesc": "Outstanding",
"MaintPriorityDesc": "",
"CreationDate": "\/Date(1600992000000)\/",
"LastChangeTime": "PT22H05M29S",
"LastChangeDate": "\/Date(1600992000000)\/",
"LastChangeDateTime": "\/Date(1601064329000+0000)\/",
"CreationTime": "PT22H05M29S",
"ReportedByUser": "Dummy",
"ReporterFullName": "Dummy",
"PersonResponsible": "",
"MalfunctionEffect": "",
"MalfunctionEffectText": "",
"MalfunctionStartDate": "\/Date(1600992000000)\/",
"MalfunctionStartTime": "PT21H05M29S",
"MalfunctionEndDate": null,
"MalfunctionEndTime": "PT00H00M00S",
"MaintNotificationCatalog": "D",
"MaintNotificationCode": "",
"MaintNotificationCodeGroup": "",
"CatalogProfile": "000000001",

This is custom documentation. For more information, please visit the SAP Help Portal 27
 6/15/2024
"NotificationCreationDate": "\/Date(1600992000000)\/",
"NotificationCreationTime": "PT21H05M29S",
"NotificationTimeZone": "UTC+1",
"RequiredStartDate": "\/Date(1600992000000)\/",
"RequiredStartTime": "PT21H05M29S",
"RequiredEndDate": null,
"RequiredEndTime": "PT00H00M00S",
"LatestAcceptableCompletionDate": null,
"MaintenanceObjectIsDown": false,
"MaintNotificationLongText": "",
"MaintNotifLongTextForEdit": "",
"TechnicalObject": "",
"TechObjIsEquipOrFuncnlLoc": "",
"TechnicalObjectLabel": "",
"MaintenancePlanningPlant": "",
"MaintenancePlannerGroup": "",
"PlantSection": "",
"ABCIndicator": "",
"SuperiorTechnicalObject": "",
"SuperiorTechnicalObjectName": "",
"SuperiorObjIsEquipOrFuncnlLoc": "",
"SuperiorTechnicalObjectLabel": "",
"ManufacturerPartTypeName": "",
"TechObjIsEquipOrFuncnlLocDesc": "",
"FunctionalLocation": "",
"FunctionalLocationLabelName": "",
"TechnicalObjectDescription": "",
"AssetLocation": "",
"LocationName": "",
"BusinessArea": "",
"CompanyCode": "",
"TechnicalObjectCategory": "",
"TechnicalObjectType": "",
"MainWorkCenterPlant": "",
"MainWorkCenter": "",
"PlantName": "",
"MaintenancePlannerGroupName": "",
"MaintenancePlant": "",
"LocationDescription": "",
"MainWorkCenterText": "",
"MainWorkCenterPlantName": "",
"MaintenancePlantName": "",
"PlantSectionPersonRespName": "",
"ABCIndicatorDesc": "",
"PersonResponsibleName": "",
"MaintenanceOrder": "",
"MaintenanceOrderType": "",
"ConcatenatedActiveSystStsName": "OSNO",
"MaintenanceActivityType": "",
"MaintObjDowntimeDurationUnit": "H",
"MaintObjectDowntimeDuration": "0",
"MaintenancePlan": "",
"MaintenanceItem": "",
"TaskListGroup": "",
"TaskListGroupCounter": "",
"MaintenancePlanCallNumber": 0,
"MaintenanceTaskListType": "",
"TaskList": "",
"NotificationReferenceDate": "\/Date(1600992000000)\/",
"NotificationReferenceTime": "PT22H05M29S",
"NotificationCompletionDate": null,
"CompletionTime": "PT00H00M00S",
"AssetRoom": "",
"MaintNotifExtReferenceNumber": "",
"MaintNotifRejectionReasonCode": "",
"MaintNotifRejectionRsnCodeTxt": "",
"to_Item": {
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102553')/
}
},
"to_Partner": {
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10102553')/

This is custom documentation. For more information, please visit the SAP Help Portal 28
 6/15/2024
}
}
}
}
--93A9530A4FDB16E620AD529CC4E28EF81--

--93A9530A4FDB16E620AD529CC4E28EF80--

Read Noti cation Item

With this operation, you can read a noti cation item.

Examples
Request

 Sample Code
<host>
/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationItem(MaintenanceNotification='100

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationItem(Mai
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationItem(Ma
"type": "cds_api_maintnotification.MaintenanceNotificationItemType"
},
"MaintenanceNotification": "10001316",
"MaintenanceNotificationItem": "1",
"MaintNotifItemText": "ItemAPI1",
"MaintNotifDamageCodeGroup": "YB-PMME1",
"MaintNotifDamageCodeGroupName": "Damages mechanical",
"MaintNotificationDamageCode": "ME02",
"MaintNotifDamageCodeName": "Difficult to move",
"MaintNotifObjPrtCodeGroup": "YB-PMME1",
"MaintNotifObjPrtCodeGroupName": "Object parts mechanical",
"MaintNotifObjPrtCode": "ME01",
"MaintNotifObjPrtCodeName": "Bearing",
"MaintNotifItemCreationDateTime": "/Date(1492098664000)/",
"MaintNotifItemChangedDateTime": "/Date(1492098664000)/",
"to_ItemActivity": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationIte
}
},
"to_ItemCause": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationIte
}
},
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationIte
}
}
}
}

This is custom documentation. For more information, please visit the SAP Help Portal 29
 6/15/2024

Create Noti cation Item

With this operation, you can create item for existing noti cation using POST requests.

Prerequisites
As for all POST operations, before you can send the Noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token, for example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual Noti cation request, you then have to add this token to the header (apart from the other headers),
see also the following example under Request.

Examples
Request

 Sample Code
POST <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationItem X-CSRF-Token: 4kY
{
"MaintenanceNotification": "10001690",
"MaintNotifItemText": "Item Create",
"MaintNotifDamageCodeGroup": "YB-PMME1",
"MaintNotificationDamageCode": "ME02",
"MaintNotifObjPrtCodeGroup": "YB-PMME1",
"MaintNotifObjPrtCode": "ME01"
}

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationItem(Mai
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationItem(Ma
"type": "cds_api_maintnotification.MaintenanceNotificationItemType"
},
"MaintenanceNotification": "10001690",
"MaintenanceNotificationItem": "0",
"MaintNotifItemText": "Item Create",
"MaintNotifDamageCodeGroup": "YB-PMME1",
"MaintNotifDamageCodeGroupName": "",
"MaintNotificationDamageCode": "ME02",
"MaintNotifDamageCodeName": "",
"MaintNotifObjPrtCodeGroup": "YB-PMME1",
"MaintNotifObjPrtCodeGroupName": "",
"MaintNotifObjPrtCode": "ME01",
"MaintNotifObjPrtCodeName": "",
"to_ItemActivity": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationIte
}
},
"to_ItemCause": {
This is custom documentation. For more information, please visit the SAP Help Portal 30
 6/15/2024
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationIte
}
},
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationIte
}
}
}
}

Update Noti cation Item

With this operation, you can update a noti cation item.

Prerequisites
As for all PATCH operations, before you can send the Noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token, for example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual Noti cation request, you then have to add this token to the header (apart from the other headers),
see also the following example under Request.

Examples
Request

 Sample Code
PATCH <host> /sap/opu/odata/SAP/API_MAINTNOTIFICATION/MaintenanceNotificationItem(MaintenanceNoti
{
"MaintNotifItemText": "Item Update",
"MaintNotifDamageCodeGroup": "YB-PMME1",
"MaintNotificationDamageCode": "ME02",
"MaintNotifObjPrtCodeGroup": "YB-PMME1",
"MaintNotifObjPrtCode": "ME01"
}

Response

 Sample Code
Sap message <notification xmlns:sap="http://www.sap.com/Protocols/SAPData"><code>EAMS_BO/029</cod

Read Noti cation Item Activity

With this operation, you can read a noti cation item activity.

This is custom documentation. For more information, please visit the SAP Help Portal 31
 6/15/2024

Examples
Request

 Sample Code
<host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity(MaintenanceNotifica

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity(M
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity
"type": "cds_api_maintnotification.MaintNotificationItemActivityType"
},
"MaintNotificationActivity": "1",
"MaintenanceNotification": "10001240",
"MaintenanceNotificationItem": "1",
"MaintNotifActivitySortNumber": "1",
"MaintNotifActyTxt": "Activity update 1288889",
"MaintNotifActivityCodeGroup": "YB-PMME1",
"NotifActivityCodeGroupText": "Activities mechanical",
"MaintNotificationActivityCode": "ME00",
"NotifActivityCodeText": "Part replaced",
"PlannedStartDate": "/Date(1492041600000)/",
"PlannedStartTime": "PT15H51M04S",
"PlannedEndDate": "/Date(1492041600000)/",
"PlannedEndTime": "PT15H51M04S",
"MaintNotifItmActyStrtDateTime": "/Date(1492098664000)/",
"MaintNotifItemActyEndDateTime": "/Date(1492098664000)/",
"MaintNotifItemActyCrtnDateTime": "/Date(1492098664000)/",
"MaintNotifItemActyChgdDateTime": "/Date(1492098664000)/"
"to_Item": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActiv
}
},
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActiv
}
}
}
}

Create Noti cation Item Activity

With this operation, you can create item activity for existing noti cation using POST requests

Prerequisites
As for all POST operations, before you can send the MaintNoti cationItemActivity request, you have to get a Cross-Site Request
Forgery (CSRF) token, for example:

HEAD <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNoti cationItemActivity X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

This is custom documentation. For more information, please visit the SAP Help Portal 32
 6/15/2024
x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual MaintNoti cationItemActivity request, you then have to add this token to the header (apart from the
other headers), see also the following example under Request.

Examples

Request

 Sample Code
POST <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity X-CSRF-Token: 4
{
"MaintenanceNotification": "10001796",
"MaintenanceNotificationItem": "1",
"MaintNotifActyTxt": "Activity Create",
"MaintNotifActivityCodeGroup": "YB-PMME1",
"MaintNotificationActivityCode": "ME02",
"PlannedStartDate": "/Date(1492041600000)/",
"PlannedStartTime": "PT15H51M04S",
"PlannedEndDate": "/Date(1492041600000)/",
"PlannedEndTime": "PT15H51M04S"
}

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity(M
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity
"type": "cds_api_maintnotification.MaintNotificationItemActivityType"
},
"MaintNotificationActivity": "0",
"MaintenanceNotification": "10001796",
"MaintenanceNotificationItem": "1",
"MaintNotifActivitySortNumber": "0",
"MaintNotifActyTxt": "Activity Create",
"MaintNotifActivityCodeGroup": "YB-PMME1",
"NotifActivityCodeGroupText": "",
"MaintNotificationActivityCode": "ME02",
"NotifActivityCodeText": "",
"PlannedStartDate": "/Date(1492041600000)/",
"PlannedStartTime": "PT15H51M04S",
"PlannedEndDate": "/Date(1492041600000)/",
"PlannedEndTime": "PT15H51M04S",
"to_Item": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActiv
}
},
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActiv
}
}
}
}

Update Noti cation Item Activity

This is custom documentation. For more information, please visit the SAP Help Portal 33
 6/15/2024
With this operation, you can update existing item activity for a noti cation.

Prerequisteis
In all PATCH operations, before you can send the MaintNotificationItemActivity request, you have to get a Cross-Site
Request Forgery (CSRF) token, for example:

 Sample Code

HEAD <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity X-CSRF-Token: f

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual MaintNotificationItemActivity request, you then have to add this token to the header
(apart from the other headers), see also the following example under Request.

Examples
Request

 Sample Code
PATCH <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemActivity(MaintenanceNot

{
"MaintNotifActyTxt": "Activity update",
"MaintNotifActivityCodeGroup": "YB-PMME1",
"MaintNotificationActivityCode": "ME00",
"PlannedStartDate": "/Date(1492041600000)/",
"PlannedStartTime": "PT15H51M04S",
"PlannedEndDate": "/Date(1492041600000)/",
"PlannedEndTime": "PT15H51M04S"
}

Response

 Sample Code
Sap message <notification xmlns:sap="http://www.sap.com/Protocols/SAPData"><code>EAMS_BO/029</cod

Read Noti cation Item Cause

With this operation, you can read a noti cation item cause.

Examples
Request

 Sample Code
<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause(MaintenanceNotification

This is custom documentation. For more information, please visit the SAP Help Portal 34
 6/15/2024

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause(Main
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause(Mai
"type": "cds_api_maintnotification.MaintNotificationItemCauseType"
},
"MaintenanceNotification": "10001316",
"MaintenanceNotificationItem": "1",
"MaintenanceNotificationCause": "1",
"MaintNotifCauseText": "Cause1",
"MaintNotifCauseCodeGroup": "YB-PMME1",
"MaintNotifCauseCodeGroupName": "Causes mechanical",
"MaintNotificationCauseCode": "ME00",
"MaintNotificationCauseCodeName": "Insufficient Lubrication",
"MaintNotificationRootCause": "",
"MaintNotificationRootCauseText": "No",
"MaintNotifItmCauseCrtnDateTime": "/Date(1492098664000)/",
"MaintNotifItmCauseChgdDateTime": "/Date(1492098664000)/"
"to_Item": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause
}
},
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause
}
}
}
}

Create Noti cation Item Cause

With this operation, you can create an item cause for an existing noti cation using POST request.

Prerequisites
As for all POST operations, before you can send the Noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token, for example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual Noti cation request, you then have to add this token to the header (apart from the other headers),
see also the following example under Request.

Examples

Request

This is custom documentation. For more information, please visit the SAP Help Portal 35
 6/15/2024

 Sample Code
POST <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause X-CSRF-Token: 4kY1
{
"MaintenanceNotification": "10001690",
"MaintenanceNotificationItem": "2",
"MaintNotifCauseText": "Cause Create",
"MaintNotifCauseCodeGroup": "YB-PMME1",
"MaintNotificationCauseCode": "ME00",
"MaintNotificationRootCause": "1"
}

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause(Main
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause(Mai
"type": "cds_api_maintnotification.MaintNotificationItemCauseType"
},
"MaintenanceNotification": "10001690",
"MaintenanceNotificationItem": "2",
"MaintenanceNotificationCause": "0",
"MaintNotifCauseText": "Cause Create",
"MaintNotifCauseCodeGroup": "YB-PMME1",
"MaintNotifCauseCodeGroupName": "",
"MaintNotificationCauseCode": "ME00",
"MaintNotificationCauseCodeName": "",
"MaintNotificationRootCause": "1",
"MaintNotificationRootCauseText": "",
"to_Item": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause
}
},
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause
}
}
}
}

Update Noti cation Item Cause

With this operation, you can update noti cation item cause data using PATCH requests.

Prerequisites
As for all PATCH operations, before you can send the Noti cation request, you have to get a Cross-Site Request Forgery (CSRF)
token, for example:

HEAD <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cation X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

This is custom documentation. For more information, please visit the SAP Help Portal 36
 6/15/2024
When you send the actual Noti cation request, you then have to add this token to the header (apart from the other headers),
see also the following example under Request.

Examples

Request

 Sample Code
PATCH <host> /sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintNotificationItemCause(MaintenanceNotif
{
"MaintNotifCauseText": "Cause Update",
"MaintNotifCauseCodeGroup": "YB-PMME1",
"MaintNotificationCauseCode": "ME00",
"MaintNotificationRootCause": "1"
}

Response

 Sample Code
Sap message <notification xmlns:sap="http://www.sap.com/Protocols/SAPData"><code>EAMS_BO/029</cod

Read Noti cation Partner

With this operation, you can read noti cation partner data.

Examples
Request

 Sample Code
Request
<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner
(MaintenanceNotification='10001678',PartnerFunction='AB',NotificationPartnerObjectNmbr='0001')

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner
"type": "cds_api_maintnotification.MaintenanceNotificationPartnerType"
},
"MaintenanceNotification": "10001678",
"PartnerFunction": "AB",
"NotificationPartnerObjectNmbr": "1",
"Partner": "50003353",
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPar
}
}

This is custom documentation. For more information, please visit the SAP Help Portal 37
 6/15/2024
}
}

Create Noti cation Partner

With this operation, you can create partner for existing noti cation using POST requests.

Prerequisites
As for all POST operations, before you can send the MaintenanceNoti cationPartner request, you have to get a Cross-Site
Request Forgery (CSRF) token, for example:

HEAD <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual MaintenanceNoti cationPartner request, you then have to add this token to the header (apart from
the other headers), see also the following example under Request.

Examples
Request

 Sample Code
POST <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner X-CSRF-Token:
{
"MaintenanceNotification": "10001690",
"PartnerFunction": "VW",
"NotificationPartnerObjectNmbr": "0",
"Partner": "50002836"
}

Response

 Sample Code
{
"d": {
"__metadata": {
"id": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner
"type": "cds_api_maintnotification.MaintenanceNotificationPartnerType"
},
"MaintenanceNotification": "10001690",
"PartnerFunction": "VW",
"NotificationPartnerObjectNmbr": "0",
"Partner": "50002836",
"to_Notif": {
"__deferred": {
"uri": "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPar
}
}
}
}

This is custom documentation. For more information, please visit the SAP Help Portal 38
 6/15/2024

Update Noti cation Partner

With this operation, you can update an existing partner for noti cation.

Prerequisites
As for all PATCH operations, before you can send the MaintenanceNoti cationPartner request, you have to get a Cross-Site
Request Forgery (CSRF) token, for example:

HEAD <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNoti cationPartner X-CSRF-Token: fetch

The Response Header then contains, for example, this data:

x-csrf-token: 4kY1WdNn18CS9xfkFx7EbA==

When you send the actual MaintenanceNoti cationPartner request, you then have to add this token to the header (apart from
the other headers), see also the following example under Request.

Examples
Request

 Sample Code
PATCH <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotificationPartner
(MaintenanceNotification='10001678',PartnerFunction='AB',NotificationPartnerObjectNmbr='0001')
X-CSRF-Token: 4kY1WdNn18CS9xfkFx7EbA==
{
"d": {
"Partner": "50003353"
}
}

Response

 Sample Code
Sap message <notification xmlns:sap="http://www.sap.com/Protocols/SAPData"><code>EAMS_BO/029</cod

Extensibility: Maintenance Noti cation API

As a key user, you can extend the OData Service API_MAINTNOTIFICATION according to your business needs.

Features
You can extend the OData Service in the Custom Fields and Logic app using the business context Maintenance Noti cation.

Custom Fields
You can enable usage of your custom elds for the data source API Maintenance Noti cation in the UI and Reports section of
the custom eld maintenance and publish your custom elds.
This is custom documentation. For more information, please visit the SAP Help Portal 39
 6/15/2024
You can add elds to the following entities:

Entity Business Context

A_MAINTENANCENOTIFICATION Maintenance Noti cation (EAMS_NTF)

See Also
For more information, see the SAP Business Accelerator Hub (https://api.sap.com/ ).

Related Information
Key User Extensibility
Custom Fields App and Custom Logic App

Maintenance Noti cation Function Import

Function imports allow custom operations that can be invoked by the HTTP methods GET or POST for anything that cannot be
mapped to the standard CRUD operations. This section contains payload examples for the following function imports:

Name Entity Set

SetMaintNotifToInProcess
 Sample Code
POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/SetMaintNotifToInProcess?Mai

CompleteMaintNoti cation
 Sample Code
POST - <host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/CompleteMaintNotification?Ma

ETags
The service uses entity tags (ETags) for optimistic concurrency control. That is, if a client requests a modi cation of a resource
in the backend server, the ETags of the resource in the client and in the backend server are compared to determine whether any
changes have been made to the resource in the backend server. For this service, the If-Match header must be set for all change
operations.

If you are not processing the latest version of a condition record, the system raises an error that stops you from saving your
changes.

Alternatively, you can also use * in If-Match that would bypass ETag check.

The Etag handling feature is implemented on the A_MaintenanceNotification entity and eld LastChangeDateTime.

Function import requires ETags to be speci ed.

Proceed as follows:

This is custom documentation. For more information, please visit the SAP Help Portal 40
 6/15/2024
In the header of function import request, a header element If-Match needs to be speci ed. The value can be obtained by making
a reading request for the entity that is being modi ed. The response contains a header eld called ETags, the value of which
should be used as the value of If-Match.

Set Maintenance Noti cation To In Process

This sets the status of maintenance noti cation to NOPR - Noti cation in process.

Entity Set: POST

 Sample Code
<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/SetMaintNotifToInProcess?MaintenanceNotification=%

HTTP Method: POST

Name Type

MaintenanceNoti cation QMNUM

Response

 Sample Code
{
"d" : {
"__metadata" : {
"id" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087')"
"uri" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087'
"type" : "cds_api_maintnotification.MaintenanceNotificationType",
"etag" : "W/\"'SADL-020200901100236C~20200901100236'\""
},
"MaintenanceNotification" : "10002087",
"MaintNotifInternalID" : "QM000010002087",
"NotificationText" : "Notification Creation Text",
"MaintPriority" : "1",
"NotificationType" : "M1",
"NotifProcessingPhase" : "3",
"NotifProcessingPhaseDesc" : "In Process",
"MaintPriorityDesc" : "1-Very High",
"CreationDate" : "\/Date(1598918400000)\/",
"LastChangeTime" : "PT10H02M35S",
"LastChangeDate" : "\/Date(1598918400000)\/",
"LastChangeDateTime" : "\/Date(1598954556000+0000)\/",
"CreationTime" : "PT09H58M42S",
"ReportedByUser" : "TEST_USER",
"ReporterFullName" : "TEST_USER",
"PersonResponsible" : "50009999",
"MalfunctionEffect" : "2",
"MalfunctionEffectText" : "Effect Text",
"MalfunctionStartDate" : "\/Date(1492041600000)\/",
"MalfunctionStartTime" : "PT15H51M04S",
"MalfunctionEndDate" : "\/Date(1492041600000)\/",
"MalfunctionEndTime" : "PT15H51M04S",
"MaintNotificationCatalog" : "D",
"MaintNotificationCode" : "VIBR",
"MaintNotificationCodeGroup" : "PUMPMECH",
"CatalogProfile" : "YB-PM0001",
"NotificationCreationDate" : "\/Date(1492041600000)\/",
"NotificationCreationTime" : "PT15H51M04S",
"NotificationTimeZone" : "UTC",
"RequiredStartDate" : "\/Date(1492041600000)\/",
"RequiredStartTime" : "PT15H51M04S",
"RequiredEndDate" : "\/Date(1492041600000)\/",

This is custom documentation. For more information, please visit the SAP Help Portal 41
 6/15/2024
"RequiredEndTime" : "PT15H51M04S",
"LatestAcceptableCompletionDate" : "\/Date(1492041600000)\/",
"MaintenanceObjectIsDown" : true,
"MaintNotificationLongText" : "09/01/2020 09:58:42 UTC Notification Long text test",
"MaintNotifLongTextForEdit" : "",
"TechnicalObject" : "000000000010001001",
"TechObjIsEquipOrFuncnlLoc" : "EAMS_EQUI",
"TechnicalObjectLabel" : "10001001",
"MaintenancePlanningPlant" : "1010",
"MaintenancePlannerGroup" : "920",
"PlantSection" : "CHE",
"ABCIndicator" : "1",
"SuperiorTechnicalObject" : "BLR1-CHM-PL1",
"SuperiorTechnicalObjectName" : "Functional location bangalore",
"SuperiorObjIsEquipOrFuncnlLoc" : "EAMS_FL",
"SuperiorTechnicalObjectLabel" : "BLR1-CHM-PL1",
"ManufacturerPartTypeName" : "MN4",
"TechObjIsEquipOrFuncnlLocDesc" : "Equipment",
"FunctionalLocation" : "BLR1-CHM-PL1",
"FunctionalLocationLabelName" : "BLR1-CHM-PL1",
"TechnicalObjectDescription" : "Motor pump for heating",
"AssetLocation" : "YB_1001",
"LocationName" : "Compressor # 1",
"BusinessArea" : "",
"CompanyCode" : "1010",
"TechnicalObjectCategory" : "M",
"TechnicalObjectType" : "9500",
"MainWorkCenterPlant" : "1010",
"MainWorkCenter" : "RES-0100",
"PlantName" : "Plant 1 DE",
"MaintenancePlannerGroupName" : "PM-Planner Mech.",
"MaintenancePlant" : "1010",
"LocationDescription" : "BANGALORE",
"MaintNotifSourceApplication" : "",
"MainWorkCenterText" : "Mechanics",
"MainWorkCenterPlantName" : "Plant 1 DE",
"MaintenancePlantName" : "Plant 1 DE",
"PlantSectionPersonRespName" : "Saun",
"PlantSectionPersonRespPhone" : "",
"ABCIndicatorDesc" : "Critical",
"PersonResponsibleName" : "Responsible Name",
"MaintenanceOrder" : "",
"MaintenanceOrderType" : "",
"ConcatenatedActiveSystStsName" : "NOPR",
"MaintenanceActivityType" : "Y02",
"MaintObjDowntimeDurationUnit" : "H",
"MaintObjectDowntimeDuration" : "0",
"MaintenancePlan" : "",
"MaintenanceItem" : "",
"TaskListGroup" : "",
"TaskListGroupCounter" : "",
"MaintenancePlanCallNumber" : 0,
"MaintenanceTaskListType" : "",
"NotificationReferenceDate" : "\/Date(1598918400000)\/",
"NotificationReferenceTime" : "PT10H02M35S",
"NotificationCompletionDate" : null,
"CompletionTime" : "PT00H00M00S",
"AssetRoom" : "RM1",
"MaintNotifExtReferenceNumber" : "TEST_REF",
"MaintNotifRejectionReasonCode" : "",
"MaintNotifRejectionRsnCodeTxt" : "",
"to_Item" : {
"__deferred" : {
"uri" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087
}
},
"to_Partner" : {
"__deferred" : {
"uri" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087
}
}
}
}

This is custom documentation. For more information, please visit the SAP Help Portal 42
 6/15/2024

Complete Maintenance Noti cation

This sets the system status of maintenance noti cation to NOCO - Noti cation completed along with reference date and time. If
reference date and time are not provided in the request, then system date and time are considered as reference date and time.

Entity Set: POST

 Sample Code
<host>/sap/opu/odata/sap/API_MAINTNOTIFICATION/CompleteMaintNotification?MaintenanceNotification=

HTTP Method: POST

Parameters

MaintenanceNoti cation QMNUM

Noti cationReferenceDate BEZDT

Noti cationReferenceTime BEZUR_D

Response

 Sample Code
{
"d" : {
"__metadata" : {
"id" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087')"
"uri" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087'
"type" : "cds_api_maintnotification.MaintenanceNotificationType",
"etag" : "W/\"'SADL-020200901102923C~20200901102923'\""
},
"MaintenanceNotification" : "10002087",
"MaintNotifInternalID" : "QM000010002087",
"NotificationText" : "Notification Creation Text",
"MaintPriority" : "1",
"NotificationType" : "M1",
"NotifProcessingPhase" : "4",
"NotifProcessingPhaseDesc" : "Completed",
"MaintPriorityDesc" : "1-Very High",
"CreationDate" : "\/Date(1598918400000)\/",
"LastChangeTime" : "PT10H29M22S",
"LastChangeDate" : "\/Date(1598918400000)\/",
"LastChangeDateTime" : "\/Date(1598956163000+0000)\/",
"CreationTime" : "PT09H58M42S",
"ReportedByUser" : "TEST_USER",
"ReporterFullName" : "TEST_USER",
"PersonResponsible" : "50009999",
"MalfunctionEffect" : "2",
"MalfunctionEffectText" : "Effect Text",
"MalfunctionStartDate" : "\/Date(1492041600000)\/",
"MalfunctionStartTime" : "PT15H51M04S",
"MalfunctionEndDate" : "\/Date(1492041600000)\/",
"MalfunctionEndTime" : "PT15H51M04S",
"MaintNotificationCatalog" : "D",
"MaintNotificationCode" : "VIBR",
"MaintNotificationCodeGroup" : "PUMPMECH",
"CatalogProfile" : "YB-PM0001",
"NotificationCreationDate" : "\/Date(1492041600000)\/",
"NotificationCreationTime" : "PT15H51M04S",
"NotificationTimeZone" : "UTC",
"RequiredStartDate" : "\/Date(1492041600000)\/",
"RequiredStartTime" : "PT15H51M04S",

This is custom documentation. For more information, please visit the SAP Help Portal 43
 6/15/2024
"RequiredEndDate" : "\/Date(1492041600000)\/",
"RequiredEndTime" : "PT15H51M04S",
"LatestAcceptableCompletionDate" : "\/Date(1492041600000)\/",
"MaintenanceObjectIsDown" : true,
"MaintNotificationLongText" : "09/01/2020 09:58:42 UTC Notification Long text test",
"MaintNotifLongTextForEdit" : "",
"TechnicalObject" : "000000000010001001",
"TechObjIsEquipOrFuncnlLoc" : "EAMS_EQUI",
"TechnicalObjectLabel" : "10001001",
"MaintenancePlanningPlant" : "1010",
"MaintenancePlannerGroup" : "920",
"PlantSection" : "CHE",
"ABCIndicator" : "1",
"SuperiorTechnicalObject" : "BLR1-CHM-PL1",
"SuperiorTechnicalObjectName" : "Functional location bangalore",
"SuperiorObjIsEquipOrFuncnlLoc" : "EAMS_FL",
"SuperiorTechnicalObjectLabel" : "BLR1-CHM-PL1",
"ManufacturerPartTypeName" : "MN4",
"TechObjIsEquipOrFuncnlLocDesc" : "Equipment",
"FunctionalLocation" : "BLR1-CHM-PL1",
"FunctionalLocationLabelName" : "BLR1-CHM-PL1",
"TechnicalObjectDescription" : "Motor pump for heating",
"AssetLocation" : "YB_1001",
"LocationName" : "Compressor # 1",
"BusinessArea" : "",
"CompanyCode" : "1010",
"TechnicalObjectCategory" : "M",
"TechnicalObjectType" : "9500",
"MainWorkCenterPlant" : "1010",
"MainWorkCenter" : "RES-0100",
"PlantName" : "Plant 1 DE",
"MaintenancePlannerGroupName" : "PM-Planner Mech.",
"MaintenancePlant" : "1010",
"LocationDescription" : "BANGALORE",
"MaintNotifSourceApplication" : "",
"MainWorkCenterText" : "Mechanics",
"MainWorkCenterPlantName" : "Plant 1 DE",
"MaintenancePlantName" : "Plant 1 DE",
"PlantSectionPersonRespName" : "Saun",
"PlantSectionPersonRespPhone" : "",
"ABCIndicatorDesc" : "Critical",
"PersonResponsibleName" : "Responsible Name",
"MaintenanceOrder" : "",
"MaintenanceOrderType" : "",
"ConcatenatedActiveSystStsName" : "NOCO",
"MaintenanceActivityType" : "Y02",
"MaintObjDowntimeDurationUnit" : "H",
"MaintObjectDowntimeDuration" : "0",
"MaintenancePlan" : "",
"MaintenanceItem" : "",
"TaskListGroup" : "",
"TaskListGroupCounter" : "",
"MaintenancePlanCallNumber" : 0,
"MaintenanceTaskListType" : "",
"NotificationReferenceDate" : "\/Date(1601251200000)\/",
"NotificationReferenceTime" : "PT10H05M10S",
"NotificationCompletionDate" : "\/Date(1598918400000)\/",
"CompletionTime" : "PT10H29M22S",
"AssetRoom" : "RM1",
"MaintNotifExtReferenceNumber" : "TEST_REF",
"MaintNotifRejectionReasonCode" : "",
"MaintNotifRejectionRsnCodeTxt" : "",
"to_Item" : {
"__deferred" : {
"uri" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087
}
},
"to_Partner" : {
"__deferred" : {
"uri" : "<HOST>/sap/opu/odata/sap/API_MAINTNOTIFICATION/MaintenanceNotification('10002087
}
}
}
}

This is custom documentation. For more information, please visit the SAP Help Portal 44
 6/15/2024

This is custom documentation. For more information, please visit the SAP Help Portal 45