| Description | Query Campaigns |
| Name | QueryCampaignIn |
| Namespace | http://sap.com/xi/AP/CRM/Global |
| Process Component Description | Campaign Management |
| Process Component Name | CampaignManagement |
| 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 that queries Campaign based on Campaign information provided by the consumer
The web service interface Query Campaign enables you to query and read Campaigns within your system. The web service interface is relevant if your company wants to access and manage Campaign data from external applications.
The web service interface Query Campaign offers the operation QueryByElements.
Here is an example of a simple web service request to get all Campaign with a certain subject name:
<n0:CampaignOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID/> <UUID/> </BasicMessageHeader> <CampaignOverviewSimpleSelectionByElements> <SelectionByLifeCycleStatusCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLifeCycleStatusCode>2</LowerBoundaryLifeCycleStatusCode> </SelectionByLifeCycleStatusCode> </CampaignOverviewSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator/> <LastReturnedObjectID/> </ProcessingConditions> </n0:CampaignOverviewSimpleByElementsQuery_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.
Query operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer (external application) is responsible for ensuring reasonable sizes for mass operations.
The query processing conditions specify how to process a query with respect to the maximum number of hits to be returned.
Query request messages provide the following processing parameters:
Query hits maximum number value (element name QueryHitsMaximumNumberValue): Maximum number of hits to be returned by an inquiry.
Query hits unlimited indicator (element name QueryHitsUnlimitedIndicator): Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by a previous inquiry.
Note: If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be filled.
Query response messages provide the following elements:
Returned query hits number value (element name ReturnedQueryHitsNumberValue): The number of hits returned by an inquiry.
More hits available indicator (element name MoreHitsAvailableIndicator): Indicates whether there are more than ReturnedQueryHitsNumberValue hits matching the selection criteria or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by this inquiry.
Note: Processing conditions can be used for the paging of query results. However, it is crucial not to change the query selection parameters from request to request. Otherwise, the query result might change.
Query selection parameters are mainly exposed as select options or ranges with an inclusion/exclusion code, interval boundary type code, lower boundary value, and upper boundary value.
The inclusion/exclusion code (element name InclusionExclusionCode) specifies the inclusion or exclusion of a set into a result set.
| Inclusion Exclusion Code | Description |
|---|---|
| E | Excluding |
| I | Including |
The interval boundary type code (element name IntervalBoundaryTypeCode) is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.
| Interval Boundary Type Code | Name | Description | |
|---|---|---|---|
| 1 | Equal to | Single value | = X |
| 2 | Between (excluding upper boundary) | Interval with closed lower and open upper boundary | [X, Y) |
| 3 | Between | Interval with open lower and open upper boundary | (X, Y) |
| 4 | Between (excluding both boundaries) | Interval with open lower and open upper boundary | (X, Y) |
| 5 | Between (excluding lower boundary) | Interval with open lower and closed upper boundary | (X, Y] |
| 6 | Less than | Interval with unlimited lower and open upper boundary | < X |
| 7 | Less Than or Equal to | Interval with unlimited lower and closed upper boundary | <= X |
| 8 | Greater Than | Interval with open lower and unlimited upper boundary | > X |
| 9 | Greater Than or Equal to | Interval with closed lower and unlimited upper boundary | = X |
Requested elements (element name RequestedElements) enable web service consumer to reduce the size of query response messages. Therefore, transmission and response times are reduced, thus avoiding timeouts.
Requested elements contain transmission request codes for controlling the transmission of corresponding query response node elements.
The transmission request codes are modeled as xml attributes following the syntax: <element name>TransmissionRequestCode.
The prefix <element name> is equivalent to the name of the node element in the response message to which the transmission request code applies.
| Transmission Request Code | Name | Description |
|---|---|---|
| 1 | Complete Structure | The node element and all its elements, its child node elements and all their elements will be returned. |
| 2 | Complete Node | The node element and all its elements will be returned. |
| 3 | Node with Key Elements | The node element and its key elements will be returned (not supported by all web service interfaces). |
| 4 | Excluded Node | The node element and its child node elements will not be returned. |
The transmission request code is optional. If no transmission request code is modeled or provided by the service consumer, then the following rules apply:
If no transmission request code is provided at all, then the response message contains all data.
If the transmission request code of the parent node element is 1, then its sub-node elements for which no transmission request code is specified are defaulted by 1.
If the transmission request code of the parent node element is 2 or 3, then its sub-node elements for which no transmission request code is specified are defaulted by 4.
If the transmission request code of the parent node element is 4, then its sub-node elements are not returned anyway.
The Query parameters can be used to get specific Campaigns in the response based on specific Campaign ID, Description, Status etc.
These parameters are enclosed in the tag <CampaignOverviewSimpleSelectionByElements>.
<SelectionByID> : This takes a numerical boundary as input. If all campaigns with IDs between 1 and 100 are required then the values to be passed are <LowerBoundaryID>1</LowerBoundaryID>,
<UpperBoundaryID>100</UpperBoundaryID>.
<SelectionBySystemAdministrativeData...> : This can be used to query Campaigns based on their Creation time<SelectionBySystemAdministrativeDataCreationDateTime> or Last change DateTime <SelectionBySystemAdministrativeDataLastChangeDateTime>.
<SelectionByCreationBusinessPartnerCommonPersonNameGivenName> : This can be used to query the Campaigns according to the Name of the Person/Employee who created the Campaign.
<SelectionByLastChangeBusinessPartnerCommonPersonNameGivenName> : This can be used to query the Campaigns according to the Name of the Person/Employee who last change the Campaign.
<SelectionByDescription> : This can be used to query the Campaigns according to the Name of the Campaign.
<SelectionByPlannedStartDate>/<SelectionByPlannedEndDate> : This can be used to query the Campaigns according to the Start/End Date of the Campaign.
<SelectionByLifeCycleStatusCode> : This can be used to query the Campaigns according to the Status of the Campaign. The code values are
as following :
1 - Planned
2 - Active
3 - Finished
4 - Cancelled
| Description | Find campaigns |
| Name | FindOverviewSimpleByElements |
| Synchronous | yes |
| Release Status | Released |
To query Campaigns using structured query selection data
Query selection parameters are mainly exposed as select options or ranges with an inclusion/exclusion code, interval boundary type code, lower boundary value, and upper boundary value.
The inclusion/exclusion code (element name InclusionExclusionCode) specifies the inclusion or exclusion of a set into a result set.
| Inclusion Exclusion Code | Description |
|---|---|
| E | Excluding |
| I | Including |
The interval boundary type code (element name IntervalBoundaryTypeCode) is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.
| Interval Boundary Type Code | Name | Description | |
|---|---|---|---|
| 1 | Equal to | Single value | = X |
| 2 | Between (excluding upper boundary) | Interval with closed lower and open upper boundary | [X, Y) |
| 3 | Between | Interval with open lower and open upper boundary | (X, Y) |
| 4 | Between (excluding both boundaries) | Interval with open lower and open upper boundary | (X, Y) |
| 5 | Between (excluding lower boundary) | Interval with open lower and closed upper boundary | (X, Y] |
| 6 | Less than | Interval with unlimited lower and open upper boundary | < X |
| 7 | Less Than or Equal to | Interval with unlimited lower and closed upper boundary | <= X |
| 8 | Greater Than | Interval with open lower and unlimited upper boundary | > X |
| 9 | Greater Than or Equal to | Interval with closed lower and unlimited upper boundary | = X |
The Query parameters can be used to get specific Campaigns in the response based on specific Campaign ID, Description, Status etc.
These parameters are enclosed in the tag <CampaignOverviewSimpleSelectionByElements>.
<SelectionByID> : This takes a numerical boundary as input. If all campaigns with IDs between 1 and 100 are required then the values to be passed are <LowerBoundaryID>1</LowerBoundaryID>,
<UpperBoundaryID>100</UpperBoundaryID>.
<SelectionBySystemAdministrativeData...> : This can be used to query Campaigns based on their Creation time<SelectionBySystemAdministrativeDataCreationDateTime> or Last change DateTime <SelectionBySystemAdministrativeDataLastChangeDateTime>.
<SelectionByCreationBusinessPartnerCommonPersonNameGivenName> : This can be used to query the Campaigns according to the Name of the Person/Employee who created the Campaign.
<SelectionByLastChangeBusinessPartnerCommonPersonNameGivenName> : This can be used to query the Campaigns according to the Name of the Person/Employee who last change the Campaign.
<SelectionByDescription> : This can be used to query the Campaigns according to the Name of the Campaign.
<SelectionByPlannedStartDate>/<SelectionByPlannedEndDate> : This can be used to query the Campaigns according to the Start/End Date of the Campaign.
<SelectionByLifeCycleStatusCode> : This can be used to query the Campaigns according to the Status of the Campaign. The code values are
as following :
1 - Planned
2 - Active
3 - Finished
4 - Cancelled
Here is an example of a simple web service request to get all Campaign with a certain subject name:
<n0:CampaignOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID/> <UUID/> </BasicMessageHeader> <CampaignOverviewSimpleSelectionByElements> <SelectionByLifeCycleStatusCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLifeCycleStatusCode>2</LowerBoundaryLifeCycleStatusCode> </SelectionByLifeCycleStatusCode> </CampaignOverviewSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator/> <LastReturnedObjectID/> </ProcessingConditions> </n0:CampaignOverviewSimpleByElementsQuery_sync>
Show full documentation
Show full documentation