User Tools

Site Tools


apis_designer

API Designer

Save

Changes made in the designer are saved in your browser's memory automatically but must be saved to the server to be effective. The Save button (top right) changes from green to amber and to red over time since the last save, or as more changes are made without saving.

Click the down arrow to the right of the button for more save options:

  • Publish - make the dashboard live
  • Backup - make a copy of the dashboard design that you can rollback to if necessary
  • Rollback - roll the design back to a saved backup or previous published version
  • Validate - check for errors in your dashboard (this is done automatically when you publish)

When you Publish or Backup you will be asked to enter Version Notes. These can be seen in the Design History if you decide to Rollback the design.

Entity Type

Choose from the following API types:

  • fData - returns some or all data from a selected DSD
  • fDocs - returns a generated fDocs document
  • fSheets - returns a generated fSheets document

Entity

Click in the entry box or on the icon to open the entity picker to select the DSD or template required, relevant to the Entity Type selected.

Further options depend on the Entity Type selected.

Data Group

fData Entity Type only By default, all data groups from the selected DSD will be returned in the API but you can restrict this to a single data group only (this will further affect the formats available).

Format

Not relevant to fSheets Entity Types The Format may be left unselected if you wish to allow the caller to choose the format required, but otherwise the options are as follows:

fData Entity Types

  • fData internal content - as used within fSeries
  • Spreadsheet generated with fSheets
  • Data group table (only for specific Data Group)
  • Key/Value pairs (only for specific Data Group) - {fieldname:value} format

See separate documentation for more details of these format options.

fDocs Entity Types Choose from the list of fDocs formats that you have available for your system.

Description and Summary

These texts will be included in the API Documentation available to other systems, providing useful information to them when accessing your API.