Enable a Resource for REST

To enable a resource to use the RESTful API Framework, follow these steps:

  1. Navigate to Tailoring > Web Services > Web Service Configuration.

  2. If needed, enter the information in the Service Name, Name, or Object Name fields to specify the resource you want to enable for RESTful.

  3. Click Search, and then select the appropriate resource from the list.

  4. Under External Access Definition, click the RESTful API tab.

  5. Check the RESTful Enabled? check box.

  6. Specify the following required fields:

    Field Function
    Resource Collection Name: This is the name of the Resource Collection.  For example, you may specify the group of incidents from the probsummary table as "incidents".
    Resource Name: This is the name of the individual Resource.  For example, you may specify that any individual incident from the probsummary table be referred to as an "Incident".
    Unique Keys This field specifies one or more fields that will function as a unique identifier for a Resource from the Resource Collection.
  7. If needed, specify the following additional fields:

    Field Function

    Resource Collection Action

    POST:

    This field represents the default action for resource collection.

    Resource Actions

    POST:

    PUT:

    DELETE:

    This field specifies the action to take when an individual resource is part of a POST, PUT, DELETE command. These actions are specified in the Allowed Actions tab of the External Access Definition.