Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.92 KB

ReportApi.md

File metadata and controls

65 lines (45 loc) · 1.92 KB

Infoplus\ReportApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method HTTP request Description
runReport GET /beta/report/{reportId}/runReport Run a specified report

runReport

runReport($report_id, $format)

Run a specified report

Run a specified report

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\ReportApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$report_id = 56; // int | Id of the report to run.
$format = "format_example"; // string | Format of the report.

try {
    $apiInstance->runReport($report_id, $format);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->runReport: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
report_id int Id of the report to run.
format string Format of the report.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]