Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following paragraph describes the configuration of the response, this is split into XSD schema set and domain schema.

When calling an external REST service, this part defines the message you (expect to) receive from the service.

When setting up a web service (BaaS), this part defines the response Blueriq will give to an incoming request.

XSD Schema Set

The image below is an example of response when using an XSD Schema Set. 

  1. The entity that is the singleton where you start capturing the response.
  2. Define the headers of your message using attributes of the response instance.
  3. You can select an entity as body element. This is the entity that captures the actual content of the response.
  4. The schema element can be added when you want to receive data that is not part of your profile, for example the justification tree.
  5. This is the 1:1 relation between the entity in (1) and the entity in (3).
  6. Here you can add validations for the response.
     
Info
  • The validations can only be validation types. It is not possible to use validation rules.
  • The Body relation is only shown when the body element has a value. It can switch to Body attribute when you only want to receive an attribute without selecting a body element. You want this if the response consist only of a single value without any representation of a structure.

Domain schema

When using a domain schema the response configuration of the body looks like the image below. Only the part that differs from XSD schema set is shown.
  1. Select the domain schema that you want to use for the response.
  2. Select the 1:1 relation from the response singleton to the domain entity that links to the content of the response.


...