RESTful Web Service

Introduction

This document provides an overview of the integration between Automate and RESTful Web Service, explaining how REST APIs can be utilized to perform standard database functions within a resource.

The integration enables users to communicate with RESTful Web Services via HTTP requests, facilitating the automation of various tasks such as creating, reading, updating, and deleting records.

What is RESTful Web Service?

Overview of RESTful Web Service: REST (Representational State Transfer) is a popular architectural style for designing networked applications. RESTful Web Services allow clients to access and manipulate resources using standard HTTP methods such as GET, POST, PUT, PATCH, and DELETE.

Key Features:

• Standard HTTP Methods: Supports CRUD operations (Create, Read, Update, Delete) using HTTP methods.

• Flexible Data Communication: Allows communication with resources using various content types including JSON, XML, and plain text.

• Scalability and Interoperability: Enables easy integration with different platforms and systems.

Automate Integration with RESTful Web Service

Overview of Integration: Automate integrates with RESTful Web Services to perform CRUD operations and interact with resources using HTTP requests.

Examples of Automated Tasks:

• Deleting records from a resource using the DELETE method.

• Retrieving data from a resource using the GET method.

• Updating existing records using the PATCH and PUT methods.

• Adding new records using the POST method.

How To Use Actions

DELETE Method

Purpose: Delete data from the source.

How to Use:

1. Enter Request URL or select from a variable containing the REST API service URL.

2. Choose authentication type and provide user information if required.

3. Add headers and specify the content type.

4. Assign the output value of the method to a string variable if needed.

GET Method

Purpose: Retrieve data from the source.

How to Use:

1. Enter Request URL or select from a variable containing the REST API service URL.

2. Choose authentication type and provide user information if required.

3. Add headers and specify the content type.

4. Add query parameters if necessary.

5. Assign the output value of the method to a string variable if needed.

PATCH Method

Purpose: Update part of the data.

How to Use:

1. Enter Request URL or select from a variable containing the REST API service URL.

2. Choose authentication type and provide user information if required.

3. Add headers and specify the content type.

4. Add body parameters to specify the data to be updated.

5. Assign the output value of the method to a string variable if needed.

POST Method

Purpose: Add or update data.

How to Use:

1. Enter Request URL or select from a variable containing the REST API service URL.

2. Choose authentication type and provide user information if required.

3. Add headers and specify the content type.

4. Add body parameters to specify the data to be added or updated.

5. Assign the output value of the method to a string variable if needed.

PUT Method

Purpose: Update data.

How to Use:

1. Enter Request URL or select from a variable containing the REST API service URL.

2. Choose authentication type and provide user information if required.

3. Add headers and specify the content type.

4. Add body parameters to specify the data to be updated.

5. Assign the output value of the method to a string variable if needed.

Additional Tips

Use Cases

FAQ (Frequently Asked Questions)