business-user-read-metadata-dd6003b.md

Business User - Read Metadata

Technical name: QueryBusinessUserMetadataIn

This service enables you to read metadata information from your external data source such as an identity management system for service Business User with this synchronous inbound service.

This service provides the search parameter RoleCategory, which restricts the result set of the metadata information of the service. The response includes the metadata information based on the given criteria. If errors occur, the log contains information about the severity code, the message number and message texts.

This service is available on the SAP Business Accelerator Hub, for more information see APIs on SAP Business Accelerator Hub.

Service Request

Service Nodes

The service nodes contain the service's business data.

---

Node or Field		Description	Cardinality
BusinessPartnerRoleCategoryInterval Cardinality: 0..unbounded	IntervalBoundaryTypeCode	You can only use the following value: 1 - Equal	1..1
	LowerBoundaryBusinessPartnerRoleCategoryCode	For example: BUP003	0..1

Sample Payload

Sample Code:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aba="http://sap.com/xi/ABA">
   <soapenv:Header/>
   <soapenv:Body>
      <aba:BusinessUserMetaDataQuery_sync>
         <!--Zero or more repetitions:-->
         <BusinessPartnerRoleCategoryInterval>
            <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
            <LowerBoundaryBusinessPartnerRoleCategoryCode>BUP003</LowerBoundaryBusinessPartnerRoleCategoryCode>
         </BusinessPartnerRoleCategoryInterval>
      </aba:BusinessUserMetaDataQuery_sync>
   </soapenv:Body>
</soapenv:Envelope>

Service Response

---

Service Node		Description	Link to Details
BusinessUserMetaData	RoleCategoryDependentMetaData	This node contains all metadata, which depends on the role category of a business user, such as the role category with its role, external ID category with its external ID type or relationship category.	RoleCategoryDependentMetaData
	CodeList	This node provides the available code lists for SAP specific codes. For example country/region code, academic title.	CodeList
Log		This nodes displays occurred messages.	Log

Error Codes

---

Error Code	Message	Description
112	Interval Boundary Type Code &1 is not supported for BusinessPartnerRoleCategoryInterval.	You can only use the following value: 1 - Equal
118	No data found by given search criteria.	To display all data, don't enter any value.

Authentication Method

You can use the following authentication methods: User ID/password (Username Token), X.509 certificate (X509 Token) or Single Sign On using SAML (SAML Token).

Constraints

Currently this SOAP service is only enabled for English.

Additional Information

If you have any issues, report an incident for component CA-GTF-BUM.

Note:

For more information about the API, choose the Details tab on the SAP Business Accelerator Hub.