Creating and editing Resources

Introduction

When you are editing an API, Resources are shown at the bottom of the menu on the left.

Internally the API Designer builds a grammatical definition of each resource. Resources are basically a grammatical description of JSON objects. It is possible for a Resource to refer to other resources.

The designer supports the following Member types for Resources:

  • Primitive Member variables: string, numeric, datetime or boolean
  • Tables (arrays) of named primitive members
  • Single instances of another Resource object
  • Arrays of other Resource objects

Viewing Resources [top]

  1. Open the API you want to view a Resource for.
  2. Click on Resources to view a list of all resources.
  3. Click on the Resource you want to view.

This screenshot shows what it looks like to view a resource in the designer:

  1. Click Resources to show/hide the list of resources.
  2. Click the + sign to create a new Resource.
  3. List of Resources — in this case there is only one resource “Person”.
  4. List of Members in the Resource object.
  5. Dependencies — the Person resource is used in two Interactions.

Creating Resources [top]

  1. Open the API you want to create a Resource for.
  2. Click on Resources, then click the Add New button.
    Note: Alternatively you can click the + sign to the right of Resources

This screenshot shows what it looks like to create a resource in the designer:

  1. The new Resource will not show in the list until after it is saved.
  2. Enter a Name and (optional) Description for the Resource.
  3. Click the + Add Member button to add a member variable.
  4. Save or Cancel changes.

Editing Resources [top]

  1. Open the API you want to view a Resource for.
  2. Click on Resources to view a list of all resources.
  3. Click on the Resource you want to edit.
  4. Click the Edit button.

This screenshot shows what it looks like to edit a resource in the designer:

  1. The Resource being edited will be highlighted in the list.
  2. Modify the Name and (optional) Description for the Resource.
  3. Edit existing members, or click the + Add Member button to add a new member variable.
  4. Save/Cancel changes or Delete the Resource.

 

Tagged:

Leave A Comment?