Skip to main content

API operations

👉 Choose Api > Operations in the main menu.

Adding custom API operations​

API operations are a great feature to add custom features to your API that are not covered by the default CRUD handlers.

wyStack automatically generates OData Functions/Actions based on your Operations. You can create global Operations (not bound to any Class) or Entity Operations (bound to a specific Class). As a result an operation can return (Operation output type):

Entities

  • A single Entity of a specific Class.
  • A List of Entities of a specific Class.

Client instructions

  • A blob/file download.
  • A message that is displayed to the end-user.
  • A link that the client can navigate to.
  • Inform client about a changed entity/data-source.
  • Inform client to completely refresh the UI.

System types

  • Any custom System Type compatible with OData. (String, Boolean, etc.)

Operation Arguments​

Optionally you can define custom operation arguments, for example int or string values.

Operation Types​

Default Operations are shown automatically in the UI, if possible. Hidden Operations are not shown, System Operations are only shown on System pages.

Anonymous Operations​

You can make Operations available without any authentication using the Is anonymous flag.