Versions Compared

Key

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

...

Code Block
titleFlex5 API Endpoint URL
https://<your-company>.flexrentalsolutions.com/f5/api/<api-path>/<path-variable(s)>/?parameterSubmission=true&<param-id-1>=<param-value-1>&<param-id2>=<param-value-2>

where api-path includes any necessary additions such as inventory-tree/nodes, where path-variable(s) includes things like modelId or documentId, and where param-id1 and param-id-2 are parameter ids as found in report-definitions.json. The parameter count can, of course, vary. In any case, if you're using a report that requires one or more parameters, your first parameter must be parameterSubmission with a value of true. If this is not included, we cannot guarantee your results

Path and Path Variable

For the Report API, the path is simply /f5/api/report and the only path variable you need is the reportId as specified in the id property of the report-definitions.json

Request Body Parameters

...