Property

Description

Optionality

Default value

Obs.

Name

Name that identifies the element in the module.

Mandatory

 

The OutSystems Platform tries to infer the name from the URL.

Description

Free text that describes the REST API.

Optional

 

You can type the text directly in the property or click on to use the editor.

Icon

The icon that identifies the REST API and its methods in the development environment.

Mandatory

Default icon for REST API.

 

Base URL

The base URL for all methods of the REST API.

Mandatory

 

This value can be configured at runtime. See more about Runtime Configuration.

Basic Authentication - The credentials to authenticate requests

Username

The username to authenticate requests of methods of the REST API.

Optional

 

This value can be configured at runtime.

Learn more about Runtime Configuration.

See an example in Use Application Authentication.

Password

The password to authenticate requests of methods of the REST API.

Optional

 

This value can be configured at runtime.

Learn more about Runtime Configurations.

See an example in Get User Authorization.

Advanced - Advanced properties of the REST API

Date Format

Indicates the date format that the REST API sends and receives.

Mandatory

2014-01-01T00:00:00Z (ISO)

 

 

On Before Request

Indicates the callback action that is executed before a request is sent. This is useful to debug and customize requests.

Optional

 

Learn more about the OnBeforeRequest callback.

Learn more about troubleshooting.

On After Response

Indicates the callback action that is executed after a response arrives. This is useful to debug and customize responses.

Optional

 

Learn more about the OnAfterResponse callback.

Learn more about troubleshooting.

HTTP Headers - Properties to add specific information to requests.

Name

The name of the HTTP Header Field sent with requests of methods of the REST API.

NA

 

See an example in Use Application Authentication.

Value

The value of the HTTP Header Field sent with requests of methods of the REST API.

NA

 

See an example in Use Application Authentication.

See Also

Retrieve Data using REST