Field | Description |
Name | This is a label that you assign as a meaningful name of the HTTP Request. For example, you may call a HTTP Request of type application/xml, as XML Request or XML Payload. You may also call a HTTP Request based on the data that it holds. For example, you could specify a POST request to create new customer as Create Customer Request. |
Description | (Optional). The description for the HTTP Request. |
Request Content-Type | The content format for the HTTP Request message. (The Request Content-Type displays a list of the supported content formats for the REST Service.) By default, this field shows an empty value. |
Schema | (Optional). The REST Payload (HTTP Request message) using an XML schema or JSON schema. |
Inline or External File | Specifies if the schema definition will be read from an inline text (the Inline option) or from an external file or URL (the External File option). To use an inline schema, type the schema definition in the Inline text box. To use an external schema, do the following: If the schema definition you are uploading resides on the network, specify its URL. If the schema definition resides in an external file, specify the file name. You can use the Browse button to navigate to the required folder. Note: As a best practice, you should use the Inline option to include small number of data and use the External File option to include large number of data stored in an external file. |
Example | (Optional). The REST Payload (HTTP Request message) with suitable examples to demonstrate the usage of a schema. An example is an XML code or JSON code. |
Inline or External File | Specifies if the example will be read from an inline example code (the Inline option) or from an external file or URL (the External File option). To use an inline example, type the example code in the Inline text box. To use an external example, do the following: If the example you are uploading resides on the network, specify its URL. If the example resides in an external file, specify the file name. You can use the Browse button to navigate to the required folder. Note: As a best practice, you should use the Inline option to include small number of data and use the External File option to include large number of data stored in an external file. |