/SyncBFBean/subscribePartnerSystem

post

https://rz3.aeb.de/test4ce/rest/SyncBFBean/subscribePartnerSystem

Subscribe a partner system to be able to receive events for the specified business object type.
The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fields).
Since XNSG 4.0, Nov. FP, 2021

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request parameter to subscribe a partner system to sync events.

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

businessObjectType

string

required

length ≤ 20

Code which identifies the subscribed business object type.

description

string

length ≤ 250

Optional description of the subscription.

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The operation result.