| Description | Query Working Time Models |
| Name | QueryWorkingTimeModelIn |
| Namespace | http://sap.com/xi/A1S |
| Process Component Description | Time and Labour Management |
| Process Component Name | TimeAndLabourManagement |
| Process Component Namespace | http://sap.com/xi/AP/TimeAndLabourManagement/Global |
| Deployment Unit Description | Human Capital Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to query working time model data.
This web service is used to query working time model.
It has the FindByElements operation which is used to query for one or more instances of the Working Time Model based on the query filter parameters passed.
Example
<n0:WorkingTimeModelByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TimeModelSelectionByElements> <SelectionByID> <SelectionByCountryCode> <SelectionByTypeCode> <SelectionByDescription> </TimeModelSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>25822</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> <LastReturnedObjectID>Token 25828</LastReturnedObjectID> </ProcessingConditions> </n0:WorkingTimeModelByElementsQuery_sync>
Due to the stateless behavior of the A2X service operations, there is no possibility to enforce any kind of transactional or logical locking. Despite that, clients may require to at least enforce that a modifying operation is not executed because the state of the underlying business object instance in the database has changed ever since the client read its data. To this end, the notion of the change state identifier ("ChangeStateID") has been introduced. From the point of view of the client, is it an uninterpretable string that is provided by all operations and may be consumed by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business object instance in the database has changed ever since the change state identifier was computed. That means specifying the change state identifier enables the client to implement optimistic locking. The only thing that is guaranteed is that the content of the string changes when the content of the business object changes. The reverse is not necessarily true and must not be accounted on.
If the change state identifier is specified and the specified value for a business object instance is different from the actual value computed from the database, and error message with the value SBM.SBM.CSM (change state mismatch, defined by the constant IF_ESI_MESSAGE_SYMPTOMS=> CO_SRVC_BO_CHNG_STATE_MISMATCH) in the element LogItem.LogItemCategoryCode shall be returned for that business object instance.
Sample xml if the wrong ChangeStateID is provided in the request:
<nm:WorkingTimeModelByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:HGM:/1SAI/TAS2A081EC31EB5E08371AA:804"> <Log> <MaximumLogItemSeverityCode>3</MaximumLogItemSeverityCode> <Item> <TypeID>031(/MBF_A2X_CORE/)</TypeID> <CategoryCode>SBM.SBM.CSM</CategoryCode> <SeverityCode>3</SeverityCode> <ReferenceObjectNodeSenderTechnicalID>72</ReferenceObjectNodeSenderTechnicalID> <Note>Update failed; change state ID 20111011112138.8012470 differs from change state ID 20111011112713.9587020 in DB</Note> </Item> </Log> </nm:WorkingTimeModelByElementsResponse_sync>
For certain nodes with cardinality from 0 - *, the UUID / TechnicalIDs are used as identifier for each of the respective nodes.
The QueryProcessingConditions specify how to process a query with respect to the maximum number of hits to be returned.
QueryHitsMaximumNumberValue: Maximum number of hits to be returned by an inquiry.
QueryHitsUnlimitedIndicator: Identifies the last object returned by a previous inquiry.
LastReturnedObjectID: Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.
If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be present.
Example
Show full documentation
Show full documentation
<ProcessingConditions>
<QueryHitsMaximumNumberValue>500</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
All the selection elements in the query have the following selection parameters.
InclusionExclusionCode: A coded representation of the inclusion of a set into a result set or the exclusion of it.
| Code Value | Description |
|---|---|
| E | Excluding |
| I | Including |
IntervalBoundaryTypeCode: A coded representation of an interval boundary type. The meaning of scale values established by the IntervalBoundaryTypeCode is used to describe intervals by their boundaries. The values that are expressed by the interval relationship must belong to the same ordinal scale.
| Code Value | 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 |
You can find general information about Web services, their structure and consumption in the Web Services documentation.
<n0:WorkingTimeModelByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TimeModelSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>PNOR2</LowerBoundaryID> </SelectionByID> </TimeModelSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>25822</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:WorkingTimeModelByElementsQuery_sync>
| Description | Find working time models |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To query working time model by elements.
FindByElements is an operation to query working time model data by the selections elements passed in the request.
Below are the list of selection elements available and their corresponding business context with the UI.
| SelectionByElements | UI Element |
|---|---|
| SelectionByID | Time Model ID |
| SelectionByCountryCode | Country |
| SelectionByTypeCode | Type |
| SelectionByDescription | Time Model Description |
Example
This is a sample request for a simple wild card query and to return only 30 working time model.
<n0:WorkingTimeModelByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TimeModelSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>*</LowerBoundaryID> </SelectionByID> </TimeModelSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>30</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:WorkingTimeModelByElementsQuery_sync>
Here is another example to query a specific working time model.
<n0:WorkingTimeModelByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TimeModelSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>PNOR2</LowerBoundaryID> </SelectionByID> </TimeModelSelectionByElements> </n0:WorkingTimeModelByElementsQuery_sync>