ReSTful Webservices: Input XML structure

When a webservice is called, a document is passed to the corresponding Technical Process. If you have defined HTTP content as input mode in the webservice configuration, this document only includes the content of the HTTP entity. Media Type and Charset from the Content Type header are transferred to the input document.

If HTTP-MetaXml has been defined as the input mode, an XML document with HTTP header information, among other things, is passed to the Technical Process during the webservice call, which is structured according to the following pattern:

XML

<Request>
  <Path>
    <Method>ReST-Methode (z. B. GET)</Method>
    <FullPath>Komplette URL inkl. konstantem und variablem URL-Part</FullPath>
    <Server>URL des Servers</Server>
    <RequestPath>Pfad, der im Aufruf verwendet wurde</RequestPath>
    <ContextPrefix>Basis-URL von X4 ReST (immer gleich)</ContextPrefix>
    <PathInfo>Konstanter und variabler URL-Part</PathInfo>
    <Parts>
      <Constant name="Konstanter URL-Part" />
      <Variable name="Name des variablen URL-Parts">tatsächl. URL-Part</Variable>
    </Parts>
  </Path>
  <Headers>
    <Header>
      <Name>Header-Name</Name>
      <Value>Header-Wert</Value>
   </Header>
   <!-- Oder bei Datumswerten: -->
   <Header>
      <Name>HTTP-Header-Name</Name>
      <Date timezone="Zeitzone">Header-Datumswert</Date>
   </Header>
  </Headers>
  <Query>
    <QueryString>Über die URL übergebene Parameter</QueryString>
    <Parameter name="Parameter-Name">Parameter-Wert</Parameter>
  </Query>
  <Security realm="Sicherheitsbereich">
     <Principal class="Prinzipalklasse" name="Prinzipal-Name" />
  </Security>
  <Body encoding="Datenkodierung">Übermittelte Daten</Body>
</Request>

The <Request> root element contains the following elements:

Element	Description
`<Path>`	Contains, among other things, the calling URL and the individual, broken down URL parts. Note: Note that when migrating from X4 BPMS 6.x to X4 BPMS 7.x, the expected contents of the `<ContextPrefix/>` and `<PathInfo/>` elements differ slightly: Example 6.x CODE `<ContextPrefix>/X4/httpstarter/ReST</ContextPrefix> <PathInfo>/ExampleReSTService/Transport1.0/ReadCustomer2.0</PathInfo>` Example 7.x CODE `<ContextPrefix>/X4/httpstarter</ContextPrefix> <PathInfo>/ReST/ExampleReSTService/Transport1.0/ReadCustomer2.0</PathInfo>`
`<Headers>`	Contains the individual HTTP headers with name and value in one `<Header>` element at a time.
	Contains the `<QueryString>` elements and, if necessary, a `<Parameter>` element for each parameter.
`<Security>`	Contains the associated JAAS subjects (simple principals or principal groups) if it is not in guest access.
`<Body>`	Contains the `base64` encoding type in the `encoding` attribute and the corresponding encoded user data as element contents.