| Description | Query Opportunity |
| Name | QueryOpportunityIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Opportunity Processing |
| Process Component Name | OpportunityProcessing |
| 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 | Not Released |
An interface that queries an opportunity based on the opportunity information provided by the consumer.
The web service interface Query Opportunity In offers the operation FindByElements.
An example of Find By Element specifying the Lower Boundary Identifier:
<n0:OpportunityByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <OpportunitySelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>31</LowerBoundaryIdentifier> </SelectionByID> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>71</LowerBoundaryIdentifier> </SelectionByID> </OpportunitySelectionByElements> </n0:OpportunityByElementsQuery_sync>
A opportunity should exist in the system in order to get a positive result.
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
<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 boundaries) |
| 3 | Between |
| 4 | Between (excl. both boundaries) |
| 5 | Between (excl. lower boundaries) |
| 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. Please open the Web Services document in a new window.
| Description | Find opportunity |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To find one or more opportunities using imported and structured data.
The Find By Elements inbound operation finds one or more opportunities based on the opportunity data.
You can query with the following parameters:
| Parameters | Description | Data Type |
|---|---|---|
| SelectionBySalesForecastExpectedProcessingDatePeriodEndDate | For query selection by end date | Identifier |
ChangeStateID - An identifier for the changed state
ID - The Opportunity ID
UUID - The unique identifier of the opportunity
Name - The description field on header level
ProspectPartyFormattedName - Name of the prospect
ProspectPartyFormattedAddress - Address of the prospect
ProspectMainContactPartyName - The prospect for whom the opportunity was created
ProspectMainContactPartyEmailURI - Email address of the prospect
ProspectMainContactPhoneNumber - Phone number of the prospect
ProspectMainContactMobileNumber - Mobile number of the prospect
MainEmployeeResponsiblePartyKey - The ID of the employee responsible for processing the opportunity
MainEmployeeResponsiblePartyName - Name of the employee responsible
SalesCycleCode - A coded representation of the sales cycle.
| Code Value | Description |
|---|---|
| 001 | General Opportunity |
SalesCyclePhaseCode - The coded representation of a sales cycle phase.
| Code Value | Description |
|---|---|
| 001 | Identify opportunity |
| 002 | Qualify opportunity |
| 003 | Develop value proposition |
| 004 | Quotation |
| 005 | Decision |
| 006 | Close |
SalesRevenueForecastRelevanceIndicator - An indicator that has exactly two mutually exclusive Boolean values.
"true" or "1"
"false" or "0"
SalesForecastProbabilityPercent - A number that relates to a comparison figure
SalesForecastExpectedRevenueAmount - Expected revenue amount
SalesForecastExpectedProcessingDatePeriod - Expected processing date
Status - Opportunity status
Show full documentation
Show full documentation