Example of SAP Gateway API traffic when updating SAP

Modified on Fri, 3 Oct at 8:11 AM

TABLE OF CONTENTS


Introduction

The local logs produced by the Desktop Client (if configured to have such logging) will produce log files reflecting the API traffic to and from the Host System (SAP in this case):

Each transfer will result in a separate folder with log files, and a user can choose to zip one or more of these and make them available for IDE support for forensic analysis - in case something is not meeting expectations.

In the above example the IEA-281 folder contains the log files when downloading (writing) to SAP and the IEA-282 contains the log files when uploading (reading) from SAP. Both of these IEAs (281 and 282) are part of a "Round Trip" agreement and the 281 is set as the "Predecessor IEA" to 282.


NOTE: It is justified to ask why we need multiple reads from SAP when we are looking at the log files for WRITING to SAP... The explanation here is that there is a construct in which a IDE SAP config can point to a particular WO and ActivityID, and from these we need to retrieve the unique SAP ID (Property "ObjectNr" with value such as: OV100675952300000001). It seems like this particular transfer was set up using this construct...since 


The files

There are typically 100s of files in the folder (and below the prefixes have been removed ot save space - example of original file:  20250930124832_055_GET_GetOrderAsync_26218051.txt), and here the list has been filtered on one particular WorkOrder (26218051):

 

FileNameContent
GET_GetOrderAsync_26218051.txthttps://sapgw.statoil.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')?$expand=OrderOperationNav/OperationConfirmationNav
GetOrderFromSAP_26218051.json(1)
GET_GetOrderAsync_26218051.txthttps://sapgw.statoil.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')?$expand=OrderOperationNav/OperationConfirmationNav
GetOrderFromSAP_26218051.json(1) same as above…
POST_SetOrderSystemStatusAsync_26218051.txthttps://sapgw.statoil.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet
GetOrderFromSAP_26218051.json(2) same as above but no expansion (see txt file content of previous file)
SetOrderSystemStatus_26218051.json{"Orderid":"26218051","OrderMethodNav":[{"ActionMethod":"RELEASE"}]}
PUT_SetOrderUserStatusAsync_26218051.txthttps://sapgw.statoil.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/StatusSet(Orderid='26218051') 
SetOrderUserStatus_26218051.json{"Txt04":"RDEX","SetInact":false,"Orderid":"26218051"}
POST_SaveOrderOnlyAsync_26218051.txthttps://sapgw.statoil.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet
GetOrderFromSAP_26218051.json(3)
ChangeOrder_26218051.json(4)


In about half of these, which are .txt files, the content is simply an endpoint of the API - and in some cases with a parameter.

The other cases are json files. They are marked (1), (2), (3) and (4) above, and each of them needs its own sections to show the content. Each will get its own "chapter" below:


(1) Reading data

The content of this file looks like this (some things are changed to make it anonymous):

{
    "d": {
        "__metadata": {
            "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')",
            "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')",
            "type": "/ILAPDE/ILAP_GW_SRV.OrderHeader"
        },
        "Orderid": "26218051",
        "Plant": "1170",
        "SysStatus": "REL  CNF  DSEX GMPS MANC NMAT PRC  SETC",
        "Maintroom": "",
        "OrderType": "PM10",
        "Userstatus": "RDEX PLAN MLTI",
        "EstimatedCosts": "0.000",
        "Planplant": "1170",
        "Currency": "NOK",
        "MnWkCtr": "C01ELE",
        "Pmacttype": "015",
        "Plangroup": "SVM",
        "FunctLoc": "1170-82E3101",
        "Maintplant": "1170",
        "Location": "L20",
        "Plsectn": "82",
        "LocWkCtr": "POM",
        "SuperiorNetwork": "9051393",
        "SuperiorActivity": "0050",
        "WbsElem": "M.O095C.21.A.0009.B5",
        "LocWbsElem": "M.O095C.21.A.0009.B5",
        "ShortText": "asdf a dsfgsdf gsgsgsd ",
        "FinishDate": "\/Date(1755280800000+0000)\/",
        "StartDate": "\/Date(1749448800000+0000)\/",
        "RevisionNumber": "HED25K3",
        "ScheduledStartTime": "\/Date(1749452400000+0000)\/",
        "ScheduledFinishTime": "\/Date(1755284400000+0000)\/",
        "MaintenanceProcessingPhaseCode": "2",
        "OrderOperationNav": {
            "results": [
                {
                    "__metadata": {
                        "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0010')",
                        "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0010')",
                        "type": "/ILAPDE/ILAP_GW_SRV.OrderOperation"
                    },
                    "Orderid": "26218051",
                    "Activity": "0010",
                    "Objnr": "OV100675952300000001",
                    "SystemStatusText": "CNF  DSEX REL",
                    "FieldUserStatus": "",
                    "ControlKey": "PM01",
                    "WorkCntr": "C01ELE",
                    "Plant": "1170",
                    "Description": "h jhg fd  hgfd hgfd yut ytyut ",
                    "NumberOfCapacities": 1,
                    "DurationNormal": "714.0",
                    "DurationNormalUnit": "H",
                    "ConstraintTypeStart": "1",
                    "StartTimeConstraint": "\/Date(1699830000000+0000)\/",
                    "ConstraintTypeFinish": "",
                    "FinishTimeConstraint": null,
                    "WorkActivity": "582.0",
                    "CalcKey": "3",
                    "UnWork": "H",
                    "WorkActual": "582.000",
                    "SystemCondition": "",
                    "StandardTextKey": "",
                    "ScheduledEarlyStartTime": "\/Date(1749452400000+0000)\/",
                    "ScheduledEarlyFinishTime": "\/Date(1755284400000+0000)\/",
                    "Transferdate": "\/Date(1759229312000)\/",
                    "OperationConfirmationNav": {
                        "results": [
                            {
                                "__metadata": {
                                    "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationConfirmationSet(ConfNo='0024592082',Orderid='26218051',Operation='0010')",
                                    "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationConfirmationSet(ConfNo='0024592082',Orderid='26218051',Operation='0010')",
                                    "type": "/ILAPDE/ILAP_GW_SRV.OperationConfirmation"
                                },
                                "ConfNo": "0024592082",
                                "Orderid": "26218051",
                                "Operation": "0010",
                                "FinConf": "",
                                "Complete": "",
                                "PostgDate": "\/Date(1748822400000)\/",
                                "ActWork": "582.0",
                                "UnWork": "H",
                                "RemWork": "254.0",
                                "UnRemWrk": "H",
                                "ExecutionStartTime": "\/Date(1748881321000+0000)\/",
                                "ExecutionFinishTime": "\/Date(1758796508000+0000)\/",
                                "ForecastFinishTime": null,
                                "ExCreatedBy": "",
                                "ExternalCreateTime": null,
                                "ConfText": ""
                            }
                        ]
                    },
                    "OperationMethodNav": {
                        "__deferred": {
                            "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0010')/OperationMethodNav"
                        }
                    }
                },
                {
                    "__metadata": {
                        "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0020')",
                        "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0020')",
                        "type": "/ILAPDE/ILAP_GW_SRV.OrderOperation"
                    },
                    "Orderid": "26218051",
                    "Activity": "0020",
                    "Objnr": "OV100675952300000002",
                    "SystemStatusText": "CNF  REL",
                    "FieldUserStatus": "",
                    "ControlKey": "PM01",
                    "WorkCntr": "POMELE",
                    "Plant": "1170",
                    "Description": "Lage tag skilt",
                    "NumberOfCapacities": 1,
                    "DurationNormal": "1.0",
                    "DurationNormalUnit": "H",
                    "ConstraintTypeStart": "",
                    "StartTimeConstraint": null,
                    "ConstraintTypeFinish": "",
                    "FinishTimeConstraint": null,
                    "WorkActivity": "1.0",
                    "CalcKey": "1",
                    "UnWork": "H",
                    "WorkActual": "1.000",
                    "SystemCondition": "",
                    "StandardTextKey": "",
                    "ScheduledEarlyStartTime": "\/Date(1754715600000+0000)\/",
                    "ScheduledEarlyFinishTime": "\/Date(1754827582000+0000)\/",
                    "Transferdate": "\/Date(1759229312000)\/",
                    "OperationConfirmationNav": {
                        "results": [
                            {
                                "__metadata": {
                                    "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationConfirmationSet(ConfNo='0028227557',Orderid='26218051',Operation='0020')",
                                    "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationConfirmationSet(ConfNo='0028227557',Orderid='26218051',Operation='0020')",
                                    "type": "/ILAPDE/ILAP_GW_SRV.OperationConfirmation"
                                },
                                "ConfNo": "0028227557",
                                "Orderid": "26218051",
                                "Operation": "0020",
                                "FinConf": "X",
                                "Complete": "X",
                                "PostgDate": "\/Date(1754784000000)\/",
                                "ActWork": "1.0",
                                "UnWork": "H",
                                "RemWork": "0.0",
                                "UnRemWrk": "H",
                                "ExecutionStartTime": "\/Date(1754715600000+0000)\/",
                                "ExecutionFinishTime": "\/Date(1754827582000+0000)\/",
                                "ForecastFinishTime": null,
                                "ExCreatedBy": "",
                                "ExternalCreateTime": null,
                                "ConfText": ""
                            }
                        ]
                    },
                    "OperationMethodNav": {
                        "__deferred": {
                            "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0020')/OperationMethodNav"
                        }
                    }
                }
            ]
        },
        "OrderMethodNav": {
            "__deferred": {
                "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')/OrderMethodNav"
            }
        }
    }
}


(2) Reading data (blanks values but with "Release" status)

The content of this file (GetOrderFromSAP_26218051.json) is:

{
    "d": {
        "__metadata": {
            "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')",
            "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')",
            "type": "/ILAPDE/ILAP_GW_SRV.OrderHeader"
        },
        "Orderid": "26218051",
        "Plant": "",
        "SysStatus": "",
        "Maintroom": "",
        "OrderType": "",
        "Userstatus": "",
        "EstimatedCosts": "0.000",
        "Planplant": "",
        "Currency": "",
        "MnWkCtr": "",
        "Pmacttype": "",
        "Plangroup": "",
        "FunctLoc": "",
        "Maintplant": "",
        "Location": "",
        "Plsectn": "",
        "LocWkCtr": "",
        "SuperiorNetwork": "",
        "SuperiorActivity": "",
        "WbsElem": "",
        "LocWbsElem": "",
        "ShortText": "",
        "FinishDate": null,
        "StartDate": null,
        "RevisionNumber": "",
        "ScheduledStartTime": null,
        "ScheduledFinishTime": null,
        "MaintenanceProcessingPhaseCode": "",
        "OrderOperationNav": {
            "__deferred": {
                "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')/OrderOperationNav"
            }
        },
        "OrderMethodNav": {
            "results": [
                {
                    "__metadata": {
                        "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderMethodSet('RELEASE')",
                        "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderMethodSet('RELEASE')",
                        "type": "/ILAPDE/ILAP_GW_SRV.OrderMethod"
                    },
                    "ActionMethod": "RELEASE"
                }
            ]
        }
    }
}


(3) Changing data

The content of this file (GetOrderFromSAP_26218051.json) is:

{
    "d": {
        "__metadata": {
            "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')",
            "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderHeaderSet('26218051')",
            "type": "/ILAPDE/ILAP_GW_SRV.OrderHeader"
        },
        "Orderid": "26218051",
        "Plant": "1170",
        "SysStatus": "",
        "Maintroom": "",
        "OrderType": "PM10",
        "Userstatus": "",
        "EstimatedCosts": "0.000",
        "Planplant": "1170",
        "Currency": "",
        "MnWkCtr": "C01ELE",
        "Pmacttype": "",
        "Plangroup": "SVM",
        "FunctLoc": "",
        "Maintplant": "1170",
        "Location": "L20",
        "Plsectn": "",
        "LocWkCtr": "",
        "SuperiorNetwork": "9051393",
        "SuperiorActivity": "0050",
        "WbsElem": "M.O095C.21.A.0009.B5",
        "LocWbsElem": "M.O095C.21.A.0009.B5",
        "ShortText": "ouytuy hg ghf jhgcd ghfs yhs trds t jfdx",
        "FinishDate": "\/Date(1755277200000+0000)\/",
        "StartDate": "\/Date(1749445200000+0000)\/",
        "RevisionNumber": "HED25K3",
        "ScheduledStartTime": "\/Date(1749427200000+0000)\/",
        "ScheduledFinishTime": null,
        "MaintenanceProcessingPhaseCode": "",
        "OrderOperationNav": {
            "results": [
                {
                    "__metadata": {
                        "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0010')",
                        "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderOperationSet(Orderid='26218051',Activity='0010')",
                        "type": "/ILAPDE/ILAP_GW_SRV.OrderOperation"
                    },
                    "Orderid": "26218051",
                    "Activity": "0010",
                    "Objnr": "OV100675952300000001",
                    "SystemStatusText": "",
                    "FieldUserStatus": "",
                    "ControlKey": "PM01",
                    "WorkCntr": "C01ELE",
                    "Plant": "1170",
                    "Description": " jhk lkjh lkjh lg f yutrd trd utrd ud ytfd uyt",
                    "NumberOfCapacities": 0,
                    "DurationNormal": "1632.0",
                    "DurationNormalUnit": "",
                    "ConstraintTypeStart": "X",
                    "StartTimeConstraint": "\/Date(1749445200000+0000)\/",
                    "ConstraintTypeFinish": "",
                    "FinishTimeConstraint": "\/Date(1755277200000+0000)\/",
                    "WorkActivity": "582.0",
                    "CalcKey": "3",
                    "UnWork": "",
                    "WorkActual": "0.000",
                    "SystemCondition": "",
                    "StandardTextKey": "",
                    "ScheduledEarlyStartTime": null,
                    "ScheduledEarlyFinishTime": null,
                    "Transferdate": null,
                    "OperationConfirmationNav": {
                        "results": [
                            {
                                "__metadata": {
                                    "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationConfirmationSet(ConfNo='0000000000',Orderid='26218051',Operation='0010')",
                                    "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationConfirmationSet(ConfNo='0000000000',Orderid='26218051',Operation='0010')",
                                    "type": "/ILAPDE/ILAP_GW_SRV.OperationConfirmation"
                                },
                                "ConfNo": "0000000000",
                                "Orderid": "26218051",
                                "Operation": "0010",
                                "FinConf": "X",
                                "Complete": "X",
                                "PostgDate": null,
                                "ActWork": "582.0",
                                "UnWork": "",
                                "RemWork": "0.0",
                                "UnRemWrk": "",
                                "ExecutionStartTime": null,
                                "ExecutionFinishTime": null,
                                "ForecastFinishTime": null,
                                "ExCreatedBy": "",
                                "ExternalCreateTime": null,
                                "ConfText": "ILAP update by AKSO"
                            }
                        ]
                    },
                    "OperationMethodNav": {
                        "results": [
                            {
                                "__metadata": {
                                    "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationMethodSet('CHANGE')",
                                    "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OperationMethodSet('CHANGE')",
                                    "type": "/ILAPDE/ILAP_GW_SRV.OperationMethod"
                                },
                                "ActionMethod": "CHANGE"
                            }
                        ]
                    }
                }
            ]
        },
        "OrderMethodNav": {
            "results": [
                {
                    "__metadata": {
                        "id": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderMethodSet('CHANGE')",
                        "uri": "https://sapgw.xxx.no/sap/opu/odata/ILAPDE/ILAP_GW_SRV/OrderMethodSet('CHANGE')",
                        "type": "/ILAPDE/ILAP_GW_SRV.OrderMethod"
                    },
                    "ActionMethod": "CHANGE"
                }
            ]
        }
    }
}

(4) Reading data (blanks values but with "Release" status)

The content of this file (ChangeOrder_26218051.json) is:

{
  "d": {
    "Orderid": "26218051",
    "OrderType": "PM10",
    "Plant": "1170",
    "Planplant": "1170",
    "MnWkCtr": "C01ELE",
    "Plangroup": "SVM",
    "Maintplant": "1170",
    "Location": "L20",
    "SuperiorNetwork": "9051393",
    "SuperiorActivity": "0050",
    "WbsElem": "M.O095C.21.A.0009.B5",
    "LocWbsElem": "M.O095C.21.A.0009.B5",
    "ShortText": "ytryutr yf jhg jfd gfsds fy gj økøjlk j  ",
    "OrderOperationNav": [
      {
        "Activity": "0010",
        "ControlKey": "PM01",
        "WorkCntr": "C01ELE",
        "Plant": "1170",
        "Description": "kjhgfghf kghf iuu iuuiy iuy  ",
        "DurationNormal": "1632",
        "ConstraintTypeStart": "X",
        "WorkActivity": "582",
        "StartTimeConstraint": "\/Date(1749445200000)\/",
        "FinishTimeConstraint": "\/Date(1755277200000)\/",
        "Objnr": "OV100675952300000001",
        "CalcKey": "3",
        "WorkActual": "0",
        "OperationConfirmationNav": [
          {
            "FinConf": "X",
            "Complete": "X",
            "ActWork": "582",
            "RemWork": "0",
            "ConfText": "ILAP update by AKSO"
          }
        ],
        "OperationMethodNav": [
          {
            "ActionMethod": "CHANGE"
          }
        ]
      }
    ],
    "StartDate": "\/Date(1749445200000)\/",
    "FinishDate": "\/Date(1755277200000)\/",
    "ScheduledStartTime": "\/Date(1749427200000)\/",
    "RevisionNumber": "HED25K3",
    "OrderMethodNav": [
      {
        "ActionMethod": "CHANGE"
      }
    ]
  }
}



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article