Versions Compared

Old Version 2

changes.mady.by.user Don Bakke

Saved on

compared with

New Version 3

changes.mady.by.user Don Bakke

Saved on

Key

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

...

  • A URL (or endpoint) that identifies a resource on a server. (Required)
  • The HTTP Method that informs the server what action is to be taken by the server. (Required)
  • A payload body that the server is expected to act upon. (Required for certain HTTP Methods like POST, PUT, and PATCH)
  • HTTP Request header(s) and corresponding value(s) to provide additional meta data to the server. (Optional)

Web APIs are handled through OpenInsight stored procedures referred to as Resource API modules (or just API modules). API modules always following this naming pattern: <ResourceName>_API. Thus, if the resource name is "customers" then the API module would be named CUSTOMERS_API*.