spanapi.api.OutputsApi

Load the API package

import 'package:spanapi/api.dart';

All URIs are relative to https://api.lab5e.com

Method	HTTP request	Description
createOutput	POST /span/collections/{collectionId}/outputs	Create output
deleteOutput	DELETE /span/collections/{collectionId}/outputs/{outputId}	Delete output
listOutputs	GET /span/collections/{collectionId}/outputs	List outputs
logs	GET /span/collections/{collectionId}/outputs/{outputId}/logs	Output logs
retrieveOutput	GET /span/collections/{collectionId}/outputs/{outputId}	Retrieve output
retrieveOutputStats	GET /span/collections/{collectionId}/outputs/{outputId}/stats	Retrieve output statistics
status	GET /span/collections/{collectionId}/outputs/{outputId}/status	Output status
updateOutput	PATCH /span/collections/{existingCollectionId}/outputs/{outputId}	Update output

createOutput

Output createOutput(collectionId, body)

Create output

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 
final body = CreateOutputBody(); // CreateOutputBody | 

try {
    final result = api_instance.createOutput(collectionId, body);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->createOutput: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String
body	CreateOutputBody

Return type

Output

Authorization

APIToken

HTTP request headers

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

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

deleteOutput

Output deleteOutput(collectionId, outputId)

Delete output

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 
final outputId = outputId_example; // String | 

try {
    final result = api_instance.deleteOutput(collectionId, outputId);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->deleteOutput: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String
outputId	String

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listOutputs

ListOutputResponse listOutputs(collectionId)

List outputs

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 

try {
    final result = api_instance.listOutputs(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->listOutputs: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String

Return type

ListOutputResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

logs

OutputLogResponse logs(collectionId, outputId)

Output logs

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 
final outputId = outputId_example; // String | 

try {
    final result = api_instance.logs(collectionId, outputId);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->logs: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String
outputId	String

Return type

OutputLogResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

retrieveOutput

Output retrieveOutput(collectionId, outputId)

Retrieve output

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 
final outputId = outputId_example; // String | 

try {
    final result = api_instance.retrieveOutput(collectionId, outputId);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->retrieveOutput: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String
outputId	String

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

retrieveOutputStats

OutputStats retrieveOutputStats(collectionId, outputId)

Retrieve output statistics

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 
final outputId = outputId_example; // String | 

try {
    final result = api_instance.retrieveOutputStats(collectionId, outputId);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->retrieveOutputStats: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String
outputId	String

Return type

OutputStats

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

status

OutputStatusResponse status(collectionId, outputId)

Output status

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final collectionId = collectionId_example; // String | 
final outputId = outputId_example; // String | 

try {
    final result = api_instance.status(collectionId, outputId);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->status: $e\n');
}

Parameters

Name	Type	Description	Notes
collectionId	String
outputId	String

Return type

OutputStatusResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

updateOutput

Output updateOutput(existingCollectionId, outputId, body)

Update output

Example

import 'package:spanapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';

final api_instance = OutputsApi();
final existingCollectionId = existingCollectionId_example; // String | 
final outputId = outputId_example; // String | 
final body = UpdateOutputBody(); // UpdateOutputBody | 

try {
    final result = api_instance.updateOutput(existingCollectionId, outputId, body);
    print(result);
} catch (e) {
    print('Exception when calling OutputsApi->updateOutput: $e\n');
}

Parameters

Name	Type	Description	Notes
existingCollectionId	String
outputId	String
body	UpdateOutputBody

Return type

Output

Authorization

APIToken

HTTP request headers

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

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

Files

OutputsApi.md

Latest commit

History

OutputsApi.md

File metadata and controls

spanapi.api.OutputsApi

Load the API package

createOutput

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOutput

Example

Parameters

Return type

Authorization

HTTP request headers

listOutputs

Example

Parameters

Return type

Authorization

HTTP request headers

logs

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveOutput

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveOutputStats

Example

Parameters

Return type

Authorization

HTTP request headers

status

Example

Parameters

Return type

Authorization

HTTP request headers

updateOutput

Example

Parameters

Return type

Authorization

HTTP request headers