Skip to content

ScriptApi.md

Latest commit

 

History

History
131 lines (86 loc) · 3.89 KB

ScriptApi.md

File metadata and controls

131 lines (86 loc) · 3.89 KB

LORISClient\ScriptApi

All URIs are relative to https://demo.loris.ca/api/v0.0.4-dev, except if the operation defines another base path.

Method HTTP request Description
runBidsImport() POST /cbigr_api/script/bidsimport Import BIDS dataset into LORIS
runTarchiveLoader() POST /cbigr_api/script/tarchiveloader Load DICOM tarchive into LORIS

runBidsImport()

runBidsImport($bids_import_request): \LORISClient\LORISClient\Model\ScriptSyncResponse

Import BIDS dataset into LORIS

Executes import_bids_dataset.py to import a BIDS dataset into LORIS.

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = LORISClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new LORISClient\Api\ScriptApi(
    // 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
);
$bids_import_request = new \LORISClient\LORISClient\Model\BidsImportRequest(); // \LORISClient\LORISClient\Model\BidsImportRequest

try {
    $result = $apiInstance->runBidsImport($bids_import_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScriptApi->runBidsImport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
bids_import_request \LORISClient\LORISClient\Model\BidsImportRequest

Return type

\LORISClient\LORISClient\Model\ScriptSyncResponse

Authorization

BearerAuth

HTTP request headers

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

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

runTarchiveLoader()

runTarchiveLoader($tarchive_loader_request): \LORISClient\LORISClient\Model\ScriptSyncResponse

Load DICOM tarchive into LORIS

Executes tarchiveLoader.pl to process a DICOM archive.

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = LORISClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new LORISClient\Api\ScriptApi(
    // 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
);
$tarchive_loader_request = new \LORISClient\LORISClient\Model\TarchiveLoaderRequest(); // \LORISClient\LORISClient\Model\TarchiveLoaderRequest

try {
    $result = $apiInstance->runTarchiveLoader($tarchive_loader_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScriptApi->runTarchiveLoader: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tarchive_loader_request \LORISClient\LORISClient\Model\TarchiveLoaderRequest

Return type

\LORISClient\LORISClient\Model\ScriptSyncResponse

Authorization

BearerAuth

HTTP request headers

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

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