| Description | Query Business Roles |
| Name | QueryIdentityBusinessRoleIn |
| Namespace | http://sap.com/xi/AP/PC/IdentityManagement/Global |
| Process Component Description | Identity Management |
| Process Component Name | IdentityManagement |
| Process Component Namespace | http://sap.com/xi/AP/PC/IdentityManagement/Global |
| Deploymnent Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
An interface to query business role.
Business roles define the profile of an employee in terms of the UIs and authorizations they need to perform their job. Especially for users created without further intervention from the administrator, the business roles are the main vehicle used for assigning the authorizations.
The web service interface Query Identity Business Role In enables you to connect external applications to your SAP Business ByDesign system and to query business roles in your system.
This web service interface is relevant if external parties or systems want to access business role data from external applications.
The web service interface Query Identity Business Role In offers the operation Find By Elements.
Existence of referenced business documents:
The following business documents are only queried and will not be created by the service operations:
Business Role
They must already exist in the system when the web service is called.
Example
The following request would query a business role with the following information:
*LowerBoundaryBusinessRoleID as TESTING0001
Request
The following sample request queries the business role with Business Role ID as TESTING0001.
<n0:IdentityBusinessRoleQueryByElementsMessageType xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BusinessRoleSelectionByElements> <SelectionById> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryBusinessRoleID>TESTING0001</LowerBoundaryBusinessRoleID> </SelectionById> <LangaugeCode>EN</LangaugeCode> </BusinessRoleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:IdentityBusinessRoleQueryByElementsMessageType>
In case of successfull execution, the response would contain the business role id and name.
The following is the response for successfull execution of the above request.
Response
<nm:IdentityBusinessRoleQueryByElementsResponseMessageType xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TAS811E02919A966B1D3FAC:804"> <BusinessRole> <ID>TESTING0001</ID> <Name languageCode="EN">TESTING BUSINESS ROLES</Name> </BusinessRole> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0313711ED28786F406DFE261B4</LastReturnedObjectID> </ProcessingConditions> </nm:IdentityBusinessRoleQueryByElementsResponseMessageType>
In case of failed execution, the response would contain error message(s).
You can find general information about Web services, their structure and consumption in the Web Services documentation.
The following example scenarios can be carried out using the business role query service.
Master Data Integration with External Applications
The following example request returns maximum of 10 records with business role IDs beginning with TEST.
Request
<n0:IdentityBusinessRoleQueryByElementsMessageType xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BusinessRoleSelectionByElements> <SelectionById> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryBusinessRoleID>TEST*</LowerBoundaryBusinessRoleID> </SelectionById> <LangaugeCode>EN</LangaugeCode> </BusinessRoleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:IdentityBusinessRoleQueryByElementsMessageType>
The following is the response for successful execution of the above request.
Response
<nm:IdentityBusinessRoleQueryByElementsResponseMessageType xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TAS811E02919A966B1D3FAC:804"> <BusinessRole> <ID>TESTING0001</ID> <Name languageCode="EN">TESTING BUSINESS ROLES</Name> </BusinessRole> <BusinessRole> <ID>TESTING0002</ID> <Name languageCode="EN">TESTING0002 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0003</ID> <Name languageCode="EN">TESTING0003 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0004</ID> <Name languageCode="EN">TESTING0004 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0005</ID> <Name languageCode="EN">TESTING0005 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0006</ID> <Name languageCode="EN">TESTING0006 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0007</ID> <Name languageCode="EN">TESTING0007 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0008</ID> <Name languageCode="EN">TESTING0008 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0009</ID> <Name languageCode="EN">TESTING0009 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING00010</ID> <Name languageCode="EN">TESTING00010 BUSINESS ROLE</Name> </BusinessRole> <ProcessingConditions> <ReturnedQueryHitsNumberValue>10</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0313711ED287B89E440607496A</LastReturnedObjectID> </ProcessingConditions> </nm:IdentityBusinessRoleQueryByElementsResponseMessageType>
The following example request returns maximum of 10 records with business role Names beginning with TEST.
Request
<n0:IdentityBusinessRoleQueryByElementsMessageType xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BusinessRoleSelectionByElements> <SelectionByName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryBusinessRoleName languageCode="EN">TEST*</LowerBoundaryBusinessRoleName> </SelectionByName> </BusinessRoleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:IdentityBusinessRoleQueryByElementsMessageType>
The following is the response for successful execution of the above request.
Response
<nm:IdentityBusinessRoleQueryByElementsResponseMessageType xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TAS811E02919A966B1D3FAC:804"> <BusinessRole> <ID>TESTING0001</ID> <Name languageCode="EN">TESTING BUSINESS ROLES</Name> </BusinessRole> <BusinessRole> <ID>TESTING0002</ID> <Name languageCode="EN">TESTING0002 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0003</ID> <Name languageCode="EN">TESTING0003 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0004</ID> <Name languageCode="EN">TESTING0004 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0005</ID> <Name languageCode="EN">TESTING0005 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0006</ID> <Name languageCode="EN">TESTING0006 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0007</ID> <Name languageCode="EN">TESTING0007 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0008</ID> <Name languageCode="EN">TESTING0008 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0009</ID> <Name languageCode="EN">TESTING0009 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING00010</ID> <Name languageCode="EN">TESTING00010 BUSINESS ROLE</Name> </BusinessRole> <ProcessingConditions> <ReturnedQueryHitsNumberValue>10</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0313711ED287B89E440607496A</LastReturnedObjectID> </ProcessingConditions> </nm:IdentityBusinessRoleQueryByElementsResponseMessageType>
The following example request returns maximum of 10 business roles.
Request
<n0:IdentityBusinessRoleQueryByElementsMessageType xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BusinessRoleSelectionByElements> <SelectionById> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryBusinessRoleID>*</LowerBoundaryBusinessRoleID> </SelectionById> <LangaugeCode>EN</LangaugeCode> </BusinessRoleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:IdentityBusinessRoleQueryByElementsMessageType>
The following is the response for successful execution of the above request.
Response
<nm:IdentityBusinessRoleQueryByElementsResponseMessageType xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TAS811E02919A966B1D3FAC:804"> <BusinessRole> <ID>TESTING0001</ID> <Name languageCode="EN">TESTING BUSINESS ROLES</Name> </BusinessRole> <BusinessRole> <ID>TESTING0002</ID> <Name languageCode="EN">TESTING0002 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0003</ID> <Name languageCode="EN">TESTING0003 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0004</ID> <Name languageCode="EN">TESTING0004 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0005</ID> <Name languageCode="EN">TESTING0005 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0006</ID> <Name languageCode="EN">TESTING0006 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0007</ID> <Name languageCode="EN">TESTING0007 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0008</ID> <Name languageCode="EN">TESTING0008 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING0009</ID> <Name languageCode="EN">TESTING0009 BUSINESS ROLE</Name> </BusinessRole> <BusinessRole> <ID>TESTING00010</ID> <Name languageCode="EN">TESTING00010 BUSINESS ROLE</Name> </BusinessRole> <ProcessingConditions> <ReturnedQueryHitsNumberValue>10</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0313711ED287B89E440607496A</LastReturnedObjectID> </ProcessingConditions> </nm:IdentityBusinessRoleQueryByElementsResponseMessageType>
Note: The messages in the log vary from system to system based on the configuration.
Querying data based on extended fields, is not possible. However the extended fields (if any) will be queried and these fields can be found in response.
| Description | Find business roles |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Deprecated |
To find a business role based on various selection parameters.
The request message of the operation Find By Elements contains the BusinessRoleSelectionByElements 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 |
|---|---|
| SelectionById | Selection by a business role ID |
| SelectionByName | Selection by business role name. The LanguageCode attribute can be omitted to search for all languages. Otherwise, it has to be specified explicitly, for example, EN for English. |
The response contains the list of found IDs, Names and processing conditions.
Note: Querying data based on extended fields, is not possible. However the extended fields (if any) will be queried and these fields can be found in response.
In this node all found business roles are contained including their data according to the RequestedElements provided in the query request.
Show full documentation
Show full documentation