Description | Query Service Agents |
Name | QueryServiceAgentIn |
Namespace | http://sap.com/xi/A1S/Global |
Process Component Description | Business Partner Data Management |
Process Component Name | BusinessPartnerDataManagement |
Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
Deployment Unit Description | Foundation |
Endpoint Activation | By Scoping of Process Component | Operations |
Release Status | Released |
An interface to query service agent master data.
The web service interface Query ServiceAgent In enables you to connect external applications to your solution, and to query and read service agents in your system. The web service interface Query Service Agent In is relevant if your company wants to access and manage business partner data from external applications.
The web service interface Query ServiceAgent In offers the operation Find By Elements.
Here is an example of a simple web service request, which seeks for all service agents related to supplier MC2000:
<n0:ServiceAgentByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ServiceAgentSelectionByElements> <SelectionByRelationshipBusinessPartnerInternalID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryInternalID>MC2000</LowerBoundaryInternalID> </SelectionByRelationshipBusinessPartnerInternalID> </ServiceAgentSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ServiceAgentByElementsQuery_sync>
Here is an excerpt of the response of the request above. It contains the relationship to the business partner MS2400:
<n0:ServiceAgentByElementsResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCL:/1SAI/TAS88ADF508712C77F329F1:804"> <ServiceAgent> <ChangeStateID> 20130612112834.2166020</ChangeStateID> <UUID>00163e03-390f-1ee2-b4ea-63938dd88f78</UUID> <InternalID>7000054</InternalID> <SystemAdministrativeData> ... </SystemAdministrativeData> <LifeCycleStatusCode>2</LifeCycleStatusCode> <GivenName>MPEACOCK</GivenName> <FamilyName>_SCM_P</FamilyName> <NameFormatCountryCode>US</NameFormatCountryCode> <GenderCode>0</GenderCode> <Relationship> <RelationshipBusinessPartnerUUID>00300571-c924-02db-b8e1-37ea328e0e0a</RelationshipBusinessPartnerUUID> <RelationshipBusinessPartnerInternalID>MC2000</RelationshipBusinessPartnerInternalID> <RoleCode>BUR025-2</RoleCode> </Relationship> <IsContactPersonForRelationship> <RelationshipBusinessPartnerUUID>00300571-c924-02db-b8e1-37ea328e0e0a</RelationshipBusinessPartnerUUID> <RelationshipBusinessPartnerInternalID>MC2000</RelationshipBusinessPartnerInternalID> <RelationshipBusinessPartnerFormattedName>AMS</RelationshipBusinessPartnerFormattedName> <MainBusinessPartnerIndicator>true</MainBusinessPartnerIndicator> <WorkplaceBusinessAddressUUID>00300571-c924-02db-b8e1-380383e48e34</WorkplaceBusinessAddressUUID> <WorkplaceOrganisationFormattedPostalAddress> <FirstLineDescription>166 South High Street</FirstLineDescription> <SecondLineDescription>Akron OH 44308</SecondLineDescription> <ThirdLineDescription>United States</ThirdLineDescription> </WorkplaceOrganisationFormattedPostalAddress> <WorkplaceOrganisationPostalAddress> <CountryCode>US</CountryCode> <RegionCode listID="US">OH</RegionCode> <CityName>Akron</CityName> <StreetPostalCode>44308</StreetPostalCode> <StreetName>South High Street</StreetName> <HouseID>166</HouseID> <TaxJurisdictionCode listID="US">OH</TaxJurisdictionCode> <TimeZoneCode>EST</TimeZoneCode> </WorkplaceOrganisationPostalAddress> <SystemAdministrativeData> <CreationDateTime>2013-06-12T11:28:34.216602Z</CreationDateTime> <CreationIdentityUUID>00163e02-88ca-1ee1-aaf7-0ef99f7062eb</CreationIdentityUUID> <LastChangeDateTime>2013-06-12T11:28:34.216602Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-88ca-1ee1-aaf7-0ef99f7062eb</LastChangeIdentityUUID> </SystemAdministrativeData> </IsContactPersonForRelationship> </ServiceAgent>
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.
The following example scenario can be carried out using requested elements.
All service agents are searched for that have Meier as family name. But only the nodes attachments and relationships are returned.
<n0:ServiceAgentByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ServiceAgentSelectionByElements> <SelectionByFamilyName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryBusinessPartnerName>Meier</LowerBoundaryBusinessPartnerName> </SelectionByFamilyName> </ServiceAgentSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements ServiceAgentTransmissionRequestCode="1"> <ServiceAgent relationshipTransmissionRequestCode="1" attachmentFolderTransmissionRequestCode="1"/> </RequestedElements> </n0:ServiceAgentByElementsQuery_sync>
Description | Find service agent |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To find service agent data by elements.
The request message of the operation "FindByElements" contains the ServiceAgentSelectionByElements node that groups all possible selection parameters. This node is described in the following sub-chapter.
This node groups all selection parameters. The selection parameters are:
Selection Parameter | Remark |
---|---|
SelectionByInternalID | Selection by internal ID (business partner ID) |
SelectionByUUID | Selection by UUID |
SelectionByFamilyName | Selection by family name |
SelectionByGivenName | Selection by given name |
SelectionBySortingFormattedName | Selection by formatted name |
SelectionByRelationshipBusinessPartnerInternalID | Selection by relationship business partner internal ID |
SelectionByRelationshipBusinessPartnerUUID | Selection by relationship business partner UUID |
SelectionByRelationshipBusinessPartnerCommonOrganisationNameFirstLineName | Selection by relationship business partner common organization name first line name |
SelectionByRelationshipBusinessPartnerCommonSortingFormattedName | Selection by relationship business partner common sorting formatted name |
SelectionBySearchText | Selection by search text. No range is used for this selection. |
The response contains the list of found service agents, log items, and processing conditions.
In this node, all found service agents are contained, including their data according to the RequestedElements provided in the query request. This includes the ChangeStateID that may be needed for subsequent change requests via web services as well.