The following is a guide to the Data Types available at Request and Response body level, and those available when defining Fields.
Request Format and Response Format #
These Data Types define the structure of the entire Request or Response body.
- When set on the Request Format tab, it defines the
Content-TypeHTTP Header to use. - When set on the Response Format tab, it defines the
AcceptHTTP Header to use.
| Data Type | Description |
|---|---|
| Unknown | No Content-Type or Accept Header is specified. |
| Xml | Specifies application/xml |
| Json | Specifies application/json |
| Form | Specifies application/x-www-form-urlencoded |
| File | Specifies multipart/form-dataTypically used when working with files. |
| PlainText | Specifies text/plainAllows sending or receiving of unformatted text. |
| SimpleFile | Cyclr will automatically set the Content-Type or Accept headers based on the file type. Used for sending and receiving files within the request or response body. |
| MultipartRelated | Specifies multipart/related“File” is often preferred over “MultipartRelated”, but “MultpartRelated” is useful when there are multiple body parts. |
| MultipartFormBoundaryDefined | Only available in the Request Format. Specifies multipart/form-data, allowing sending of multiple parts, e.g. JSON and File in the same request.When working with this Data Type, you create one or more “Boundaries” which represent the different parts of the request to be sent. Each Boundary has its own Data Type: File, Json, or PlainText. Fields in the Request Format can then be defined as appearing within those Boundaries by setting their “Part” option to which Boundary they should appear in. If you don’t specify a Part for a Field, it won’t be included in the Request. |
| CSV | Use when working with CSV content. Cyclr will operate on the original CSV content, rather than converting it into a JSON equivalent. |
Fields #
These Data Types can be set to define individual fields in the Request and Response Formats.
Cyclr will also use the Data Types set on Fields when converting data to/from them.
| Data Type | Description | Example Values |
|---|---|---|
| Undefined | Value will be passed unformatted. | |
| Text | Value is a string. | abc |
| Integer | Values are whole numbers. | 123 |
| Float | Number, rounded to 14 decimal places. | 123.45678901234568 |
| Boolean | Used for true or false values. | true |
| DateTime | Values contain dates and perhaps time parts. Use the additional “Format” property to specify how the value should be formatted. | 2022-04-17T01:34:40.24Z |
| File | Holds the contents of a file. | |
| Decimal | Number, rounded to 12 decimal places. | 123.456789012346 |