Page History

In contrast to importing a WSDL, no service definition is automatically generated. You have to manually define how the REST service is called manually. . This section explains how you can configure a REST service object in Studio that uses either an XSD or domain schema.

Create a new REST service object and give your REST service in Studio (the lowest button on the left sidebar, see the screenshot above) and give it a name. Next, you need to specify the location of the REST service. This is an URLa URL. You can already specify fragments and arguments here, but then you cannot change them later. For example, check http://services.faa.gov/airport/status/IAD?format=xml. In this case, airport, status and IAD are dynamic fragments and can change, depending on input by the user. You would only use http://services.faa.gov/ as location in this case.

Now you specify how the communication is specified. This can either be a domain schema, or an XSD schema set. You have to choose one XSD schema set here that has to include everything for the entire web service. In contrast, by choosing a domain schema, you will choose later what domain schema to use for every separate method.

You can specify as many operations as you need, by pressing on the plus icon. Give every operation a unique name.

Request

1. If you want to dynamically change the address or send custom headers or body in your message, you need to specify a singleton entity from where the information is gathered

1. .
2. Here the URL is shown that will be called. Items within {} are dynamic and determined at runtime.
3. You can add static fragments

1. which are always the same,
2. or dynamic fragments

1. which are filled by attributes of the request entity.
2. You can specify arguments

1. of your request the same way.
2. There are 4 different HTTP methods: GET, POST, PUT and DELETE. Most likely, the web service works with the GET method. This method does not alter the state of the web service and just asks for information.

Response

Now you can specify how your the format of the response message looks like. If you need to set headers, then you can do so at (1) in the same way you set arguments or fragments for the request. If you need to send information in the body of the message, for example with a POST message, then you can specify this now. This screen looks different depending on if whether you send information using an XSD schema set or a domain schema.

We explain the XSD schema set first. If you have a SimpleType in the schema, then you fill in an attribute at (4). If it is a complexType, then first choose which entity will be sent at (2) and then your attribute field (4) will switch to a relation field. Fill in the name of the relation between your singleton response entity and your data entity. Custom Schema Elements (3) are ways to fill in your schema in a different way other than with data from your profile. It is not needed at the moment (An example is a justification tree)

When using a domain schema, you now simply select the domain schema that you want to use to send information (2). Furthermore, you have to select a body relation (3). This is a relation between the singleton response entity of your message and the entity that is chosen as the root entity in your domain schema.