Versions Compared

Key

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

...

As mentioned in the Getting Started wiki, you will need an authorization token for your Request Header. For the remainder of your request, you have a couple of options. You can follow a syntax similar to that used in Flex4 XML-based data producer report development and put your query parameters in the URL, or you can put them in the Request Body.

URL-based Parameters

If you opt for using the URL method, the XML-based data producer URL looks like this:

...

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, the first "true" parameter is always parameterSubmission with a value of true. If this is not included, we cannot guarantee your results

Request Body Parameters

If you choose to utilize your Request Body, simply organize the parameters and their values according to the specification you're using. For example, if you use Swagger UI to test this endpoint, you will get a request in CURL like: 

...