Aurigma\RenderingService\RenderingJobsApi

All URIs are relative to http://localhost.

Method	HTTP request	Description
renderingJobsCreate()	POST /api/rendering/v1/jobs	Creates a new rendering job and starts its execution from the very first task.
renderingJobsDelete()	DELETE /api/rendering/v1/jobs/{id}	Deletes specified rendering job.
renderingJobsDiscard()	POST /api/rendering/v1/jobs/{id}/discard	Discards the specified rendering job and prevents its further execution.
renderingJobsGet()	GET /api/rendering/v1/jobs/{id}	Returns a rendering job by ID.
renderingJobsGetAll()	GET /api/rendering/v1/jobs	Returns all rendering jobs relevant to the specified query parameters.
renderingJobsRecover()	POST /api/rendering/v1/jobs/{id}/recover	Recovers the specified rendering job and continues its execution from the failed task.
renderingJobsRestart()	POST /api/rendering/v1/jobs/{id}/restart	Restarts the specified rendering job and begins its execution from the very first task.
renderingJobsStart()	POST /api/rendering/v1/jobs/{id}/start	Starts the specified rendering job that has never been executed.

`renderingJobsCreate()`

renderingJobsCreate($start_immediately, $tenant_id, $user_id, $create_rendering_job_dto): \Aurigma\RenderingService\Model\RenderingJobDto

Creates a new rendering job and starts its execution from the very first task.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$start_immediately = true; // bool | Indicates if rendering job execution should be started immediately.
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.
$create_rendering_job_dto = new \Aurigma\RenderingService\Model\CreateRenderingJobDto(); // \Aurigma\RenderingService\Model\CreateRenderingJobDto | Create operation parameters.

try {
    $result = $apiInstance->renderingJobsCreate($start_immediately, $tenant_id, $user_id, $create_rendering_job_dto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start_immediately	bool	Indicates if rendering job execution should be started immediately.	[optional] [default to true]
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]
create_rendering_job_dto	\Aurigma\RenderingService\Model\CreateRenderingJobDto	Create operation parameters.	[optional]

Return type

\Aurigma\RenderingService\Model\RenderingJobDto

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

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

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

`renderingJobsDelete()`

renderingJobsDelete($id, $tenant_id): \Aurigma\RenderingService\Model\RenderingJobDto

Deletes specified rendering job.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$id = 'id_example'; // string | Rendering job unique identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->renderingJobsDelete($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Rendering job unique identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\RenderingService\Model\RenderingJobDto

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`renderingJobsDiscard()`

renderingJobsDiscard($id, $tenant_id, $user_id): bool

Discards the specified rendering job and prevents its further execution.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$id = 'id_example'; // string | Rendering job unique identifier.
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.

try {
    $result = $apiInstance->renderingJobsDiscard($id, $tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsDiscard: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Rendering job unique identifier.
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]

Return type

bool

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`renderingJobsGet()`

renderingJobsGet($id, $tenant_id, $user_id): \Aurigma\RenderingService\Model\RenderingJobDto

Returns a rendering job by ID.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$id = 'id_example'; // string | Rendering job unique identifier.
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.

try {
    $result = $apiInstance->renderingJobsGet($id, $tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Rendering job unique identifier.
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]

Return type

\Aurigma\RenderingService\Model\RenderingJobDto

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`renderingJobsGetAll()`

renderingJobsGetAll($status, $project_id, $skip, $take, $sorting, $tenant_id, $user_id): \Aurigma\RenderingService\Model\PagedOfRenderingJobDto

Returns all rendering jobs relevant to the specified query parameters.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$status = new \Aurigma\RenderingService\Model\\Aurigma\RenderingService\Model\RenderingJobStatus(); // \Aurigma\RenderingService\Model\RenderingJobStatus | Rendering job status filter.
$project_id = 56; // int | Rendering job associated project filter.
$skip = 56; // int | Defines page start offset from beginning of sorted result list.
$take = 56; // int | Defines page length (how much consequent items of sorted result list should be taken).
$sorting = 'sorting_example'; // string | Defines sorting order of result list e.g.: \"Title ASC, LastModified DESC\".
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.

try {
    $result = $apiInstance->renderingJobsGetAll($status, $project_id, $skip, $take, $sorting, $tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
status	\Aurigma\RenderingService\Model\RenderingJobStatus	Rendering job status filter.	[optional]
project_id	int	Rendering job associated project filter.	[optional]
skip	int	Defines page start offset from beginning of sorted result list.	[optional]
take	int	Defines page length (how much consequent items of sorted result list should be taken).	[optional]
sorting	string	Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".	[optional]
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]

Return type

\Aurigma\RenderingService\Model\PagedOfRenderingJobDto

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`renderingJobsRecover()`

renderingJobsRecover($id, $tenant_id, $user_id): bool

Recovers the specified rendering job and continues its execution from the failed task.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$id = 'id_example'; // string | Rendering job unique identifier.
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.

try {
    $result = $apiInstance->renderingJobsRecover($id, $tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsRecover: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Rendering job unique identifier.
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]

Return type

bool

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`renderingJobsRestart()`

renderingJobsRestart($id, $tenant_id, $user_id): bool

Restarts the specified rendering job and begins its execution from the very first task.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$id = 'id_example'; // string | Rendering job unique identifier.
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.

try {
    $result = $apiInstance->renderingJobsRestart($id, $tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsRestart: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Rendering job unique identifier.
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]

Return type

bool

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`renderingJobsStart()`

renderingJobsStart($id, $tenant_id, $user_id): bool

Starts the specified rendering job that has never been executed.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\RenderingService\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\RenderingService\Api\RenderingJobsApi(
    // 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
);
$id = 'id_example'; // string | Rendering job unique identifier.
$tenant_id = 56; // int | Tenant identifier.
$user_id = 'user_id_example'; // string | Rendering job owner.

try {
    $result = $apiInstance->renderingJobsStart($id, $tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RenderingJobsApi->renderingJobsStart: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Rendering job unique identifier.
tenant_id	int	Tenant identifier.	[optional]
user_id	string	Rendering job owner.	[optional]

Return type

bool

Authorization

apiKey, jwtBearer, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

RenderingJobsApi.md

Latest commit

History

RenderingJobsApi.md

File metadata and controls

Aurigma\RenderingService\RenderingJobsApi

renderingJobsCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsDiscard()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsRecover()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsRestart()

Example

Parameters

Return type

Authorization

HTTP request headers

renderingJobsStart()

Example

Parameters

Return type

Authorization

HTTP request headers

`renderingJobsCreate()`

`renderingJobsDelete()`

`renderingJobsDiscard()`

`renderingJobsGet()`

`renderingJobsGetAll()`

`renderingJobsRecover()`

`renderingJobsRestart()`

`renderingJobsStart()`