Skip to main content

Add API Parameters

Video walkthrough for adding parameters to custom API Commands in Encompass, with tips on restrictive inputs and JSON Schema validation. Requires v24.01+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 24.01

Steps

How to Add an API Parameter

Best Practices

  • Parameters should be as restrictive as possible to ensure the API Command is receiving valid input. This is important for keeping your API Commands maintainable into the future

  • If you are passing in JSON and using the JSON Schema validation, json-everything.net can be used to validate your schema and the input against it.

  • Note: Encompass uses the latest version of JSON Schema by default, unless your schema explicitly references a certain JSON Schema version. Not all historical versions will be supported, very old versions do drop support.

Did this answer your question?