Property

Description

Optionality

Default value

Obs.

Name

Name of the REST method.

Mandatory

 

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

Description

Free text that describes the REST method.

Optional

 

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

URL Path

Indicates the path of the REST method inside the Base Path of the REST API.

Mandatory

 

See more about REST API Properties.

HTTP Method

The HTTP method to execute the request:

  • GET: to retrieve data;
  • POST: to create data;
  • PUT: to update data;
  • PATCH:to update data;
  • DELETE: to delete data.

Mandatory

 

 

Request Format

The content format of the request body:

  • JSON: for JSON content;
  • Form URL Encoded;
  • Binary: for binary content;
  • Plain Text: for other content like, for example, XML.

Mandatory for the following HTTP methods:

  • POST
  • PUT
  • PATCH

 

 

Response Format

The content format of the response body:

  • JSON: for JSON content;
  • Binary: for binary content;
  • Plain Text: for other content like, for example, XML.

Mandatory

 

 

Timeout in seconds

Defines the maximum time in seconds the OutSystems Platform waits for the response to the request of the REST method.

Optional

100

If there is no value specified in this property, the time-out is 100 seconds.

More...

Edit other properties of the REST method.

 

 

 

See Also

Retrieve Data using REST