| Description | Query Read Access Logs |
| Name | QueryReadAccessLogIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Information Life Cycle Management |
| Process Component Name | InformationLifeCycleManagement |
| Process Component Namespace | http://sap.com/xi/AP/PC/InformationLifeCycleManagement/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to query read access log data
The web service interface Query Read Access Log In enables you to connect external applications to your solution and to query and read read access logs in your system. The web service interface Query Read Access Log In is relevant if your company wants to access read access log data from external applications.
The web service interface Query Read Access Log In offers the operation Find By Elements.
Here is an example of a simple web service request, which seeks for all read access logs between 15-11-2017 00:00 to 23:00 :
<n0:ReadAccessLogByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ReadAccessLogSelectionByElements> <SelectionByStartDateTime> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>8</IntervalBoundaryTypeCode> <LowerBoundaryDateTime>2017-11-15T00:00:00.0000000Z</LowerBoundaryDateTime> </SelectionByStartDateTime> <SelectionByEndDateTime> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>6</IntervalBoundaryTypeCode> <LowerBoundaryDateTime>2017-11-15T23:00:00.0000000Z</LowerBoundaryDateTime> </SelectionByEndDateTime> </ReadAccessLogSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>20</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ReadAccessLogByElementsQuery_sync>
Here is an excerpt of the response of the request above. It contains the Log size and Log data:
<n0:ReadAccessLogByElementsResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ReadAccessLog> <ChangeStateID>20171115190842.0762890</ChangeStateID> <UUID>00163e17-efcf-1ed7-b2c7-0c8dfa27261d</UUID> <StartDateTime>2017-11-15T07:54:16Z</StartDateTime> <EndDateTime>2017-11-15T19:08:39Z</EndDateTime> <LogSize>5665.0</LogSize> <LogData> <LogContent fileName="log_2017-11-15_07-54-16_00163E17EFCF1ED7B2C70C8DFA27261D.zip">...</LogContent> <LogSignature fileName="log_2017-11-15_07-54-16_00163E17EFCF1ED7B2C70C8DFA27261D.sig"/> </LogData> </ReadAccessLog> ... <ReadAccessLog> <ChangeStateID>20171115162732.1707340</ChangeStateID> <UUID>00163e17-efcf-1ee7-b2c4-3c156b041f22</UUID> <StartDateTime>2017-11-15T07:54:16Z</StartDateTime> <EndDateTime>2017-11-15T16:27:29Z</EndDateTime> <LogSize>5606.0</LogSize> <LogData> <LogContent fileName="log_2017-11-15_07-54-16_00163E17EFCF1EE7B2C43C156B041F22.zip">...</LogContent> <LogSignature fileName="log_2017-11-15_07-54-16_00163E17EFCF1EE7B2C43C156B041F22.sig"/> </LogData> </ReadAccessLog> <ProcessingConditions> <ReturnedQueryHitsNumberValue>9</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E17EFCF1EE7B2C43C156B041F22</LastReturnedObjectID> </ProcessingConditions> </n0:ReadAccessLogByElementsResponse_sync>
Here is one more example of a simple web service request, which seeks for a particular read access log entry based on UUID:
<n0:ReadAccessLogByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ReadAccessLogSelectionByElements> <SelectionByUUID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryUUID>00163E17-EFCF-1ED7-B2C7-17BADB8F2621</LowerBoundaryUUID> </SelectionByUUID> </ReadAccessLogSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ReadAccessLogByElementsQuery_sync>
Here is an excerpt of the response of the request above. It contains the Log size and Log data:
<n0:ReadAccessLogByElementsResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ReadAccessLog> <ChangeStateID>20171115191111.5946670</ChangeStateID> <UUID>00163e17-efcf-1ed7-b2c7-17badb8f2621</UUID> <StartDateTime>2017-11-15T07:54:16Z</StartDateTime> <EndDateTime>2017-11-15T19:10:48Z</EndDateTime> <LogSize>5730.0</LogSize> <LogData> <LogContent fileName="log_2017-11-15_07-54-16_00163E17EFCF1ED7B2C717BADB8F2621.zip">...</LogContent> <LogSignature fileName="log_2017-11-15_07-54-16_00163E17EFCF1ED7B2C717BADB8F2621.sig"/> </LogData> </ReadAccessLog> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E17EFCF1ED7B2C717BADB8F2621</LastReturnedObjectID> </ProcessingConditions> </n0:ReadAccessLogByElementsResponse_sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
The following example scenario can be carried out using requested elements.
All read access logs are searched for that between 15-11-2017 00:00 to 23:00 . But only the header is returned containing just log size.
<n0:ReadAccessLogByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ReadAccessLogSelectionByElements> <SelectionByStartDateTime> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>8</IntervalBoundaryTypeCode> <LowerBoundaryDateTime>2017-11-15T00:00:00.0000000Z</LowerBoundaryDateTime> </SelectionByStartDateTime> <SelectionByEndDateTime> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>6</IntervalBoundaryTypeCode> <LowerBoundaryDateTime>2017-11-15T23:00:00.0000000Z</LowerBoundaryDateTime> </SelectionByEndDateTime> </ReadAccessLogSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>20</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements ReadAccessLogTransmissionRequestCode="1"> <ReadAccessLog LogDataTransmissionRequestCode="4"/> </RequestedElements> </n0:ReadAccessLogByElementsQuery_sync>
Here is an excerpt of the response of the request above. It contains just the Log size:
<n0:ReadAccessLogByElementsResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ReadAccessLog> <ChangeStateID>20171115190842.0762890</ChangeStateID> <UUID>00163e17-efcf-1ed7-b2c7-0c8dfa27261d</UUID> <StartDateTime>2017-11-15T07:54:16Z</StartDateTime> <EndDateTime>2017-11-15T19:08:39Z</EndDateTime> <LogSize>5665.0</LogSize> </ReadAccessLog> ... <ReadAccessLog> <ChangeStateID>20171115162732.1707340</ChangeStateID> <UUID>00163e17-efcf-1ee7-b2c4-3c156b041f22</UUID> <StartDateTime>2017-11-15T07:54:16Z</StartDateTime> <EndDateTime>2017-11-15T16:27:29Z</EndDateTime> <LogSize>5606.0</LogSize> </ReadAccessLog> <ProcessingConditions> <ReturnedQueryHitsNumberValue>9</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E17EFCF1EE7B2C43C156B041F22</LastReturnedObjectID> </ProcessingConditions> </n0:ReadAccessLogByElementsResponse_sync>
| Description | Find read access logs |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To find read access log data by elements.
The request message of the operation "FindByElements" contains the ReadAccessLogSelectionByElements node that groups all possible selection parameters. This node is described in the following sub-chapter.
This node groups all selection parameters. The selection parameters are:
| Selection Parameter | Remark |
|---|---|
| SelectionByUUID | Selection by UUID |
| SelectionByStartDateTime | Selection by Start Date Time |
| SelectionByEndDateTime | Selection by End Date Time |
Interval Boundary Type Code for Date Time selection parameters are below.
| Selection Parameter | Description |
|---|---|
| 1 | Equal To |
| 2 | Between (excl. upper boundary) |
| 3 | Between |
| 4 | Between (excl. both boundaries) |
| 5 | Between (excl. lower boundary) |
| 6 | Less Than |
| 7 | Less Than or Equal to |
| 8 | Greater Than |
| 9 | Greater Than or Equal to |
The response contains the list of found read access logs, log items, and processing conditions.
| Release | Change Description | Details |
|---|---|---|
| 1802 | Service created | To query read access log data |
Show full documentation
Show full documentation