Skip to content

ProcessApi.md

Latest commit

 

History

History
156 lines (92 loc) · 3.24 KB

ProcessApi.md

File metadata and controls

156 lines (92 loc) · 3.24 KB

Swagger\Client\ProcessApi

All URIs are relative to https://localhost/

Method HTTP request Description
cancelProcess POST /api/Processes/{id}/Cancel
getProcess GET /api/Processes/{id}
getProcesses GET /api/Processes

cancelProcess

cancelProcess($id)

Example

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


$api_instance = new Swagger\Client\Api\ProcessApi();
$id = "id_example"; // string | 


try { 
    $api_instance->cancelProcess($id);
} catch (Exception $e) {
    echo 'Exception when calling ProcessApi->cancelProcess: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getProcess

\Swagger\Client\Model\Process getProcess($id)

Example

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


$api_instance = new Swagger\Client\Api\ProcessApi();
$id = "id_example"; // string | 


try { 
    $result = $api_instance->getProcess($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessApi->getProcess: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Swagger\Client\Model\Process

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getProcesses

\Swagger\Client\Model\Process[] getProcesses($all_status, $all_time)

Example

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


$api_instance = new Swagger\Client\Api\ProcessApi();
$all_status = true; // bool | 
$all_time = true; // bool | 


try { 
    $result = $api_instance->getProcesses($all_status, $all_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessApi->getProcesses: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
all_status bool [optional]
all_time bool [optional]

Return type

\Swagger\Client\Model\Process[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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