Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

New tools can be intimidating to use. Sometimes it is helpful to review a general outline of the tool's functionality before jumping in. The following
information is intended for just this purpose.

Table of Contents

Before we Begin

This article assumes that the SRP HTTP Framework has already been installed. If you need help with this process, please visit our Getting Started page our Getting Started page and following the steps provided.

A Typical Work Flow

Defining our Resource

Developers start by thinking about a resource they  they want to expose to the internet. A resource can be almost anything, but typically a resource will have will have a close relationship to a database table in the OpenInsight application. To illustrate, we'll define a resource that relates to a CUSTOMERS database CUSTOMERS database table. 

We'll use the the Resource Manager to  to define our resource. Most of the time, our resources will appear directly underneath the API endpoint (i.e.,  they they are primary resources). To do this we select the the api resource  resource node from the the Resource Manager tree  tree view, click on the the New Resource button button,  and and enter the name of the new resource:

Image Modified

Enabling our Methods

Once our resource has been defined, we need to enable those HTTP methods that we want to support. ThisThis