| Description | Query Service Requests |
| Name | QueryServiceRequestIn_V1 |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Service Request Processing |
| Process Component Name | ServiceRequestProcessing |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deployment Unit Description | Customer Relationship Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to query service requests.
This web service is used to query service requests. It has the FindByElements operation which is used to query for one or more instances of the service request based on the query filter parameters passed.
Request
<n0:ServiceRequestByElementsQueryV1_sync xmlns:n0='http://sap.com/xi/SAPGlobal20/Global'> <ServiceRequestSelectionByElements> <SelectionById> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>117</LowerBoundaryIdentifier> <UpperBoundaryIdentifier></UpperBoundaryIdentifier> </SelectionById> </ServiceRequestSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>201</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator></QueryHitsUnlimitedIndicator> <LastReturnedObjectID></LastReturnedObjectID> </ProcessingConditions> </n0:ServiceRequestByElementsQueryV1_sync>
Response
All the details of the service request which match the query parameters are displayed.
The processing conditions tag helps in providing generic parameters such as limit to the number of hits, if it is unlimited or limited to particular number.
From the tag <ReturnedQueryHitsNumberValue> in the reponse, you can find out how many records were returned.
<ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E073D621ED3B2DB1C149A2597EF</LastReturnedObjectID> </ProcessingConditions>
The query parameters can be any of those given in the WSDL. For example, <Selection_By_ID>,<SelectionByDateTime>, <SelectionByName>, <SelectionByBuyerID>, etc.
Processing conditions should be filled as following:
Processing conditions should be provided for executing the query.
Processing conditions define the limit for the number of queries to be returned. You can even set the unlimited indicator to true for returning unlimited number of (records or all possible records which match the query parameters.)
The code is for inclusive and exclusive indicator:
| InclusionExclusionCode | Description |
|---|---|
| I(Inclusive) | includes code which has to be included in the query selection |
| E(Exclusive) | excludes code which has to be excluded from the query selection |
This code is used to define the boundary details for the query parameter.
The list of Interval Boundary TypeCodes is as follows:
| IntervalBoundaryTypeCode | Description |
|---|---|
| 1 | Equal To |
| 2 | Between (excluding- upper boundary) |
| 3 | Between |
| 4 | Between (excluding- both boundaries) |
| 5 | Between (excluding- lower boundary) |
| 6 | Less Than |
| 7 | Less Than or Equal to |
| 8 | Greater Than |
| 9 | Greater Than or Equal to |
Lower boundary and upper boundary for the particular parameter with which the query should be executed can be defined here.
Upper boundary is used to find the records between given interval.
Many external applications using the web services have special requirements and restrictions for the formatting WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is sufficient for the creation of static client proxies. Other external applications, which do not create static client-side proxies, require binding WSDLs including the endpoint definition and authentication policy information.
In both cases, it will be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute 'minOccurs=0' as 'mandatory'. If 'minOccurs=0', that means 'optional' in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute 'nillable=true' must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature Due to the complexity of the WSDL they may result in long runtimes during serialization of the request or deserialization of the response. In order to avoid this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to acknowledge that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and key users. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Request
<SelectionById> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>117</LowerBoundaryIdentifier> <UpperBoundaryIdentifier></UpperBoundaryIdentifier> </SelectionById>
| Description | Find service requests |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To query service request by elements.
This is the sole operation of the web service and is used to query for service requests.
Below is the list of selection elements available and their corresponding business context with the UI.
| SelectionByElements | UI Element |
|---|---|
| SelectionById | Service Request ID |
| SelectionByBuyerID | External Refrenece |
| SelectionByName | Subject |
| SelectionByDataOriginTypeCode | Origin |
| SelectionByOrderLifeCycleStatus | Status |
| SelectionBySystemAdministrativeDataCreationDateTime | Created On |
| SelectionBySystemAdministrativeDataLastChangeDateTime | Changed On |
| SelectionByBuyerPartyID | Account |
| SelectionByProcessorPartyID | Processor |
| SelectionByServiceExecutionTeamPartyID | Service and Support Team |
| SelectionByPartyID | Party ID |
| SelectionByPartyRoleCode | Party Role |
| SelectionByServiceTermsServicePriorityCode | Priority |
| SelectionByServiceTermsServiceIssueCategoryCatalogueServiceCategoryKey | Service Category |
| SelectonByServiceReferenceObjectReferenceProductKey | Reference Product |
| SelectonByServiceReferenceObjectRegisteredProductKey | Registered Product |
SelectionByID
With this query parameter you can query service requests with a specific service request ID. The value depends on the number range that you have defined for the service request business object in your system.
SelectionByBuyerID
With this query parameter you can query service requests with a specific external reference.
SelectionByName
With this query parameter you can query service requests with a specific subject.
SelectionByLifeCycleStatusCode
| LifeCycleStatusCode | Description |
|---|---|
| 1 | Open |
| 2 | In Process |
| 3 | Completed |
| 4 | Closed |
SelectionBySystemAdministrativeDataCreationDateTime
With this parameter you can search for service requests that were created in a time interval defined by lower boundary and upper boundary. The format of the field is YYYY-MM-DDTHH:MM:SSZ
SelectionBySystemAdministrativeDataLastChangeDateTime
With this parameter you can search for service requests that were modified in a time interval defined by lower boundary and upper boundary. The format of the field is YYYY-MM-DDTHH:MM:SSZ
Where YYYY is the year (for example 2011)
MM is the month (for example 12)
DD is the day(for example 31)
HH is the hours
MM is the minutes
SS is the seconds
SelectionByBuyerPartyID
With this parameter you can search for service requests of a specific account.
SelectionByProcessorPartyID
With this parameter you can search for service requests of a specific processor.
SelectionByPartyID
With this parameter you can search for service requests by a specific party ID.
SelectionByPartyRoleCode
With this parameter you can search for service requests by a specific party role.
| Party Role | Description |
|---|---|
| 1 | Account |
| 2 | Seller |
| 5 | Product Recipient |
| 28 | Service Support Team |
| 40 | Processor |
| 44 | Sales Unit |
SelectionByServiceTermsServicePriorityCode
With this parameter you can search for service requests by a specific priority.
SelectionByServiceTermsServiceIssueCategoryCatalogueServiceCategoryKey
With this parameter you can search for service requests based on service category.
SelectonByServiceReferenceObjectReferenceProductKey
With this parameter you can search for service requests for specific reference product.
SelectonByServiceReferenceObjectRegisteredProductKey
With this parameter you can search for service requests for specific registered product.
ID - The service request ID
UUID - The unique identifier of the service request
Name - The subject of the service request
Status - The service request life cycle status code
| 1 | Open |
| 2 | In Process |
| 3 | Completed |
| 4 | Closed |
BusinessTransactionDocumentReference - structure node
PeriodTerms - structure node
DurationTerms - structure node
TimePointTerms - structure node
ServiceReferenceObject - structure node storing reference and registered product
ServiceTerms - structure node
ProcessorParty - structure node
ServiceExecutionParty - structure node
SalesUnitParty - structure node
BuyerParty - structure node
TextCollection - structure node of notes and incident description
This Operation of the interface supports extensibility.
Request
<SelectionById> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>117</LowerBoundaryIdentifier> <UpperBoundaryIdentifier></UpperBoundaryIdentifier> </SelectionById>
Show full documentation
Show full documentation