Description | Query Service Orders |
Name | QueryServiceOrderIn |
Namespace | http://sap.com/xi/A1S/Global |
Product | SAP Business ByDesign |
Process component | Service Order Processing |
Process component namespace | http://sap.com/xi/AP/CRM/Global |
Deployment unit | Customer Relationship Management |
Endpoint Activation | By Scoping of Process Component | Operations |
|
Release Status | Released |
Technical documentation on the SAP API Business Hub | Query Service Orders |
General web service documentation | A2X Web Services (SOAP) |
An interface to query service order data.
This web service is used to query service orders.
It has the FindByElements operation which is used to query for one or more instances of the Service Order based on the query filter parameters passed.
Example to query Service Orders changed after a particular date time:
<?xml version="1.0" encoding="UTF-8"?> <n0:ServiceOrderByElementsQuery_SYNC xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ServiceOrderSelectionByElements> <SelectionByLastChangedDate> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>8</IntervalBoundaryTypeCode> <LowerBoundaryDateTime>2012-01-01T00:00:00.000Z</LowerBoundaryDateTime> </SelectionByLastChangedDate> </ServiceOrderSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ServiceOrderByElementsQuery_SYNC>
Due to the stateless behaviour of the A2X service operations, there is no possiblity 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 every since the change state identifier was computed. That means specifying the change state identifier enables the client to implement optimisic 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:
<?xml version="1.0" encoding="UTF-8"?> <nm:ServiceOrderBundleMaintainConfirmation_synC xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QKA:/1SAI/TAE88DF3AA925C3E49C60CC:803"> <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:ServiceOrderBundleMaintainConfirmation_synC>
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
<?xml version="1.0" encoding="UTF-8"?> <n0:ServiceOrderByElementsQuery_SYNC xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ServiceOrderSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>101</LowerBoundaryID> </SelectionByID> </ServiceOrderSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ServiceOrderByElementsQuery_SYNC>
<n0:ServiceOrderByElementsResponse_synC xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS217C0284A68B305A5DA6:804"> <ServiceOrder> <ID>101</ID> <UUID>00163e5f-4da7-1ee9-a1bb-94beed06b402</UUID> <PostingDate>2019-06-03T08:50:34Z</PostingDate> <Name languageCode="EN"> </Name> <DataOriginTypeCode>1</DataOriginTypeCode> <ServiceConfirmationCreationCode>1</ServiceConfirmationCreationCode> <Item> <ID>10</ID> <ProcessingTypeCode>SVP1</ProcessingTypeCode> <PostingDate>2019-06-03T08:50:34Z</PostingDate> <Description languageCode="EN">On-Site Maintenance - Gas Boilers</Description> <FulfilmentPartyCategoryCode>1</FulfilmentPartyCategoryCode> <ItemProduct> <ProductID>MCD-0492</ProductID> <ProductInternalID>MCD-0492</ProductInternalID> <UnitOfMeasure>HUR</UnitOfMeasure> </ItemProduct> <PriceAndTaxCalculationItem> <Status> <CalculationStatusCode>2</CalculationStatusCode> </Status> <CountryCode>US</CountryCode> <TaxationCharacteristicsCode listID="US">501</TaxationCharacteristicsCode> <TaxationCharacteristicsDeterminationMethodCode>2</TaxationCharacteristicsDeterminationMethodCode> <TaxJurisdictionCode listID="US">MA</TaxJurisdictionCode> <TaxRegionCode listID="US">MA</TaxRegionCode> <ItemMainPrice> <Description languageCode="EN">Price List Akron Products</Description> <TypeCode listID="2">7PR1</TypeCode> <CategoryCode>1</CategoryCode> <PurposeCode>1000</PurposeCode> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemMainPrice> <ItemMainTotal> <Description languageCode="EN">Total Item Net Value</Description> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemMainTotal> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374037402</UUID> <Description languageCode="EN">Cost</Description> <MajorLevelOrdinalNumberValue>81</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <TypeCode listID="2">0008</TypeCode> <CategoryCode>1</CategoryCode> <PurposeCode>4110</PurposeCode> <Rate> <DecimalValue>26.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">26.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <ManuallyChangedIndicator>true</ManuallyChangedIndicator> <OriginCode>2</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374039402</UUID> <Description languageCode="EN">Price List Akron Products</Description> <MajorLevelOrdinalNumberValue>10</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <TypeCode listID="2">7PR1</TypeCode> <CategoryCode>1</CategoryCode> <PurposeCode>1000</PurposeCode> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef37403b402</UUID> <Description languageCode="EN">Total Item Net Value</Description> <MajorLevelOrdinalNumberValue>50</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef37403d402</UUID> <Description languageCode="EN">Total Item Net Value</Description> <MajorLevelOrdinalNumberValue>78</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef37403f402</UUID> <Description languageCode="EN">Total Net Value</Description> <MajorLevelOrdinalNumberValue>80</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374041402</UUID> <Description languageCode="EN">Profit Margin</Description> <MajorLevelOrdinalNumberValue>83</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>7.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">7.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374043402</UUID> <Description languageCode="EN">Profit Margin (%)</Description> <MajorLevelOrdinalNumberValue>84</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>21.212</DecimalValue> <MeasureUnitCode>P1</MeasureUnitCode> </Rate> <CalculationBasis> <BaseCode>1</BaseCode> <Amount currencyCode="USD">33.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">7.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374045402</UUID> <Description languageCode="EN">Tax Values</Description> <MajorLevelOrdinalNumberValue>90</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <TypeCode listID="2">0TTE</TypeCode> <CategoryCode>4</CategoryCode> <PurposeCode>5100</PurposeCode> <Rate> <DecimalValue>0.0</DecimalValue> <MeasureUnitCode>P1</MeasureUnitCode> </Rate> <CalculationBasis> <BaseCode>1</BaseCode> <Amount currencyCode="USD">33.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">0.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <GroupedIndicator>true</GroupedIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374047402</UUID> <Description languageCode="EN">Total</Description> <MajorLevelOrdinalNumberValue>100</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>34.65</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">34.65</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374049402</UUID> <Description languageCode="EN">Item Discounts</Description> <MajorLevelOrdinalNumberValue>110</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>0.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">0.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef37404b402</UUID> <Description languageCode="EN">Header Discounts</Description> <MajorLevelOrdinalNumberValue>111</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>0.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">0.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef37404d402</UUID> <Description languageCode="EN">Total Given Discounts (%)</Description> <MajorLevelOrdinalNumberValue>112</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <Rate> <DecimalValue>0.0</DecimalValue> <MeasureUnitCode>P1</MeasureUnitCode> </Rate> <CalculationBasis> <BaseCode>1</BaseCode> <Amount currencyCode="USD">33.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">0.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef37404f402</UUID> <Description languageCode="EN">Price List Akron Products</Description> <MajorLevelOrdinalNumberValue>940</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>1</MinorLevelOrdinalNumberValue> <TypeCode listID="2">7PR1</TypeCode> <CategoryCode>1</CategoryCode> <PurposeCode>1000</PurposeCode> <Rate> <DecimalValue>33.0</DecimalValue> <CurrencyCode>USD</CurrencyCode> <BaseDecimalValue>1.0</BaseDecimalValue> <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode> </Rate> <RateBaseQuantityTypeCode>TIME</RateBaseQuantityTypeCode> <CalculationBasis> <BaseCode>3</BaseCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <Amount currencyCode="USD">0.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">33.0</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <OriginCode>3</OriginCode> </ItemPriceComponent> <ItemPriceComponent> <UUID>00163e5f-4da7-1ee9-a1bb-9ef374055402</UUID> <Description languageCode="EN">State sales tax (%)</Description> <MajorLevelOrdinalNumberValue>90</MajorLevelOrdinalNumberValue> <MinorLevelOrdinalNumberValue>2</MinorLevelOrdinalNumberValue> <TypeCode listID="2">US11</TypeCode> <CategoryCode>4</CategoryCode> <PurposeCode>5100</PurposeCode> <Rate> <DecimalValue>5.0</DecimalValue> <MeasureUnitCode>P1</MeasureUnitCode> </Rate> <CalculationBasis> <BaseCode>1</BaseCode> <Amount currencyCode="USD">33.0</Amount> </CalculationBasis> <CalculatedAmount currencyCode="USD">1.65</CalculatedAmount> <RoundingDifferenceAmount currencyCode="USD">0.0</RoundingDifferenceAmount> <EffectiveIndicator>true</EffectiveIndicator> <OriginCode>1</OriginCode> </ItemPriceComponent> </PriceAndTaxCalculationItem> <UUID>00163e5f-4da7-1ee9-a1bb-9dec75c93402</UUID> <ItemScheduleLine> <ID>1</ID> <TypeCode>1</TypeCode> <Quantity unitCode="HUR">1.0</Quantity> <QuantityTypeCode>TIME</QuantityTypeCode> <DateTimePeriod> <StartDateTime timeZoneCode="CET">2019-06-04T22:00:00Z</StartDateTime> <EndDateTime timeZoneCode="CET">2019-06-05T22:00:00Z</EndDateTime> </DateTimePeriod> </ItemScheduleLine> <ItemInvoiceTerms> <ProposedInvoiceDate>2019-12-05</ProposedInvoiceDate> <InvoicingIrrelevant>true</InvoicingIrrelevant> </ItemInvoiceTerms> </Item> <Status> <PaymentAuthorisationStatusCode>4</PaymentAuthorisationStatusCode> <ItemListCancellationStatusCode>1</ItemListCancellationStatusCode> <ItemListCustomerOrderLifeCycleStatusCode>2</ItemListCustomerOrderLifeCycleStatusCode> <ItemListFulfilmentProcessingStatusCode>1</ItemListFulfilmentProcessingStatusCode> <ItemListPlanningReleaseStatusCode>3</ItemListPlanningReleaseStatusCode> <ItemListExecutionReleaseStatusCode>3</ItemListExecutionReleaseStatusCode> <ConfirmationIssuingStatusCode>1</ConfirmationIssuingStatusCode> <ItemListInvoiceProcessingStatusCode>1</ItemListInvoiceProcessingStatusCode> <ItemListProductAvailabilityConfirmationStatusCode>1</ItemListProductAvailabilityConfirmationStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> <GeneralDataCompletenessStatusCode>3</GeneralDataCompletenessStatusCode> <InvoicingBlockingStatusCode>1</InvoicingBlockingStatusCode> <FulfilmentBlockingStatusCode>1</FulfilmentBlockingStatusCode> <ReleaseStatusCode>3</ReleaseStatusCode> </Status> <ProcessingTypeCode>SRVO</ProcessingTypeCode> <TypeCode>117</TypeCode> <DurationTerms> <DurationRoleCode>18</DurationRoleCode> <Duration>P2D</Duration> </DurationTerms> <DurationTerms> <DurationRoleCode>34</DurationRoleCode> <Duration>P4D</Duration> </DurationTerms> <DurationTerms> <DurationRoleCode>35</DurationRoleCode> <Duration>P2D</Duration> </DurationTerms> <DurationTerms> <DurationRoleCode>83</DurationRoleCode> <Duration>P3DT16H</Duration> </DurationTerms> <PeriodTerms> <PeriodRoleCode>43</PeriodRoleCode> <TimePointPeriod> <IntervalBoundaryTypeCode> </IntervalBoundaryTypeCode> <StartTimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-04T22:00:00Z</DateTime> </StartTimePoint> <EndTimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-05T22:00:00Z</DateTime> </EndTimePoint> </TimePointPeriod> <StartTimePointDateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>16</DateCalculationFunctionCode> </StartTimePointDateCalculationFunctionReference> <EndTimePointDateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>17</DateCalculationFunctionCode> </EndTimePointDateCalculationFunctionReference> </PeriodTerms> <ServiceReferenceObject> <ID>00163E5F4DA71EE9A1BB94BEED06B40200163E5F4DA71EE9A1BB94BEED077402</ID> <MainIndicator>true</MainIndicator> </ServiceReferenceObject> <ServiceTerms> <ServicePriorityCode>3</ServicePriorityCode> <ServiceProvisionLocationTypeCode>1</ServiceProvisionLocationTypeCode> <ServiceLevelObjectiveID>MCSL-0201</ServiceLevelObjectiveID> <ServiceLevelObjectiveUUID>00000000-0001-02dc-ae83-336bb494d9b0</ServiceLevelObjectiveUUID> <ServiceLevelDeterminationMethodCode>1</ServiceLevelDeterminationMethodCode> </ServiceTerms> <ServicePointLocation> <AddressReference> <AddressHostUUID>00163e5f-4da7-1ee9-9ed7-9bb24d486024</AddressHostUUID> <AddressHostTypeCode>9</AddressHostTypeCode> <BusinessObjectTypeCode>147</BusinessObjectTypeCode> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC6049</PartyID> </PartyKey> </AddressReference> <RoleCode>8</RoleCode> <RoleCategoryCode>8</RoleCategoryCode> <DeterminationMethodCode>4</DeterminationMethodCode> </ServicePointLocation> <ServiceAndSupportParty> <PartyKey> <PartyTypeCode>410</PartyTypeCode> <PartyID>MC45320</PartyID> </PartyKey> <PartyUUID>00145ef5-88e6-02db-b8b3-b7f5f3b28b9d</PartyUUID> <RoleCategoryCode>28</RoleCategoryCode> <RoleCode>28</RoleCode> <AddressReference> <AddressHostUUID>00145ef5-88e6-02db-b8b3-b8133a525117</AddressHostUUID> <AddressHostTypeCode>9</AddressHostTypeCode> </AddressReference> <DeterminationMethodCode>8</DeterminationMethodCode> <MainIndicator>true</MainIndicator> </ServiceAndSupportParty> <ProcessorParty> <PartyKey> <PartyTypeCode>167</PartyTypeCode> <PartyID>MC3055</PartyID> </PartyKey> <PartyUUID>00300571-c7cc-02db-bcdf-15877bfc026d</PartyUUID> <RoleCategoryCode>40</RoleCategoryCode> <RoleCode>40</RoleCode> <AddressReference> <AddressHostUUID>00163e01-26b9-1ee0-99a2-b824bbfe9ae5</AddressHostUUID> <AddressHostTypeCode>9</AddressHostTypeCode> </AddressReference> <DeterminationMethodCode>8</DeterminationMethodCode> <MainIndicator>true</MainIndicator> </ProcessorParty> <SalesUnitParty> <PartyKey> <PartyTypeCode>410</PartyTypeCode> <PartyID>MC45000</PartyID> </PartyKey> <PartyUUID>00145ef5-88e6-02db-b8b3-b68e94e4d26a</PartyUUID> <RoleCategoryCode>44</RoleCategoryCode> <RoleCode>44</RoleCode> <AddressReference> <AddressHostUUID>00145ef5-88e6-02db-b8b3-b6baf0fa5988</AddressHostUUID> <AddressHostTypeCode>9</AddressHostTypeCode> </AddressReference> <DeterminationMethodCode>4</DeterminationMethodCode> <MainIndicator>true</MainIndicator> </SalesUnitParty> <BuyerParty> <PartyKey> <PartyTypeCode>159</PartyTypeCode> <PartyID>MC6049</PartyID> </PartyKey> <PartyUUID>00300571-ce9b-1ded-89de-7bbf95cdd98f</PartyUUID> <RoleCategoryCode>1</RoleCategoryCode> <RoleCode>1001</RoleCode> <AddressReference> <AddressHostUUID>00163e5f-4da7-1ee9-9ed7-9bb24d486024</AddressHostUUID> <AddressHostTypeCode>9</AddressHostTypeCode> </AddressReference> <DeterminationMethodCode>1</DeterminationMethodCode> <MainIndicator>true</MainIndicator> </BuyerParty> <RequestedFullfilmentPeriodTerms> <TimePointRoleCode>43</TimePointRoleCode> <TimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-04T22:00:00Z</DateTime> </TimePoint> <DateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>16</DateCalculationFunctionCode> </DateCalculationFunctionReference> </RequestedFullfilmentPeriodTerms> <CompletionDueTimePointTerms> <TimePointRoleCode>80</TimePointRoleCode> <TimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-18T21:00:00Z</DateTime> </TimePoint> <DateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>30</DateCalculationFunctionCode> </DateCalculationFunctionReference> </CompletionDueTimePointTerms> <FirstReactionDueTimePointTerms> <TimePointRoleCode>84</TimePointRoleCode> <TimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-10T21:00:00Z</DateTime> </TimePoint> <DateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>20</DateCalculationFunctionCode> </DateCalculationFunctionReference> </FirstReactionDueTimePointTerms> <RequestInitialReceiptTimePointTerms> <TimePointRoleCode>98</TimePointRoleCode> <TimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-03T08:50:34Z</DateTime> </TimePoint> <DateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>9</DateCalculationFunctionCode> </DateCalculationFunctionReference> </RequestInitialReceiptTimePointTerms> <PlannedArrivalAtCustomerTimePointTerms> <TimePointRoleCode>179</TimePointRoleCode> <TimePoint> <TypeCode>5</TypeCode> <DateTime timeZoneCode="CET">2019-06-17T21:00:00Z</DateTime> </TimePoint> <DateCalculationFunctionReference> <DateCalculationFunctionGroupCode> </DateCalculationFunctionGroupCode> <DateCalculationFunctionCode>60</DateCalculationFunctionCode> </DateCalculationFunctionReference> </PlannedArrivalAtCustomerTimePointTerms> </ServiceOrder> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E5F4DA71EE9A1BB94BEED06B402</LastReturnedObjectID> </ProcessingConditions> </n0:ServiceOrderByElementsResponse_synC>
Release | Change Description | Details |
---|---|---|
2002 | Node ItemInvoiceTerms added | New element InvoicingIrrelevant added to response message type node ItemInvoiceTerms. |
Description | Find service orders |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To query service orders by elements.
FindByElements is an operation to query service order 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 | Service Order ID |
SelectionByBuyerID | External Refrenece |
SelectionByDataOriginTypeCode | Origin |
SelectionByOrderLifeCycleStatus | Status |
SelectionByReleaseStatusCode | Release Status |
SelectionByProductID | Product ID |
SelectionByLastChangedDate | Changed on |
"IntervalBoundaryTypeCode" field is a mandatory field in each of the Selection tags. This field takes values as given in the generic document.
In the ProcessingConditions tag, "QueryHitsUnlimitedIndicator" field is mandatory which takes value 'True' or 'False'.
The format in which the date should be given is YYYY-MM-DDThh:mm:ss(.sss)Z
Example: 2012-11-27T15:30:00Z
This Operation of the interface supports extensibility.
This is a sample request for a simple wild card query and to return only 30 orders.
<?xml version="1.0" encoding="UTF-8"?> <n0:ServiceOrderByElementsQuery_SYNC xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ServiceOrderSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>*</LowerBoundaryID> </SelectionByID> </ServiceOrderSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>30</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ServiceOrderByElementsQuery_SYNC>
Here is another example to query a specific sales order.
<?xml version="1.0" encoding="UTF-8"?> <n0:ServiceOrderByElementsQuery_SYNC xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ServiceOrderSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>127213</LowerBoundaryID> </SelectionByID> </ServiceOrderSelectionByElements> </n0:ServiceOrderByElementsQuery_SYNC>