Com.Lab5e.Span.Api.OutputsApi

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 (string collectionId, CreateOutputBody body)

Create output

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class CreateOutputExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 
            var body = new CreateOutputBody(); // CreateOutputBody | 

            try
            {
                // Create output
                Output result = apiInstance.CreateOutput(collectionId, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.CreateOutput: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateOutputWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create output
    ApiResponse<Output> response = apiInstance.CreateOutputWithHttpInfo(collectionId, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.CreateOutputWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
body	CreateOutputBody

Return type

Output

Authorization

APIToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

DeleteOutput

Output DeleteOutput (string collectionId, string outputId)

Delete output

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class DeleteOutputExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 
            var outputId = "outputId_example";  // string | 

            try
            {
                // Delete output
                Output result = apiInstance.DeleteOutput(collectionId, outputId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.DeleteOutput: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteOutputWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete output
    ApiResponse<Output> response = apiInstance.DeleteOutputWithHttpInfo(collectionId, outputId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.DeleteOutputWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
outputId	string

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

ListOutputs

ListOutputResponse ListOutputs (string collectionId)

List outputs

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class ListOutputsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 

            try
            {
                // List outputs
                ListOutputResponse result = apiInstance.ListOutputs(collectionId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.ListOutputs: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ListOutputsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List outputs
    ApiResponse<ListOutputResponse> response = apiInstance.ListOutputsWithHttpInfo(collectionId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.ListOutputsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string

Return type

ListOutputResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

Logs

OutputLogResponse Logs (string collectionId, string outputId)

Output logs

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class LogsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 
            var outputId = "outputId_example";  // string | 

            try
            {
                // Output logs
                OutputLogResponse result = apiInstance.Logs(collectionId, outputId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.Logs: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the LogsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Output logs
    ApiResponse<OutputLogResponse> response = apiInstance.LogsWithHttpInfo(collectionId, outputId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.LogsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
outputId	string

Return type

OutputLogResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

RetrieveOutput

Output RetrieveOutput (string collectionId, string outputId)

Retrieve output

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class RetrieveOutputExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 
            var outputId = "outputId_example";  // string | 

            try
            {
                // Retrieve output
                Output result = apiInstance.RetrieveOutput(collectionId, outputId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.RetrieveOutput: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RetrieveOutputWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve output
    ApiResponse<Output> response = apiInstance.RetrieveOutputWithHttpInfo(collectionId, outputId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.RetrieveOutputWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
outputId	string

Return type

Output

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

RetrieveOutputStats

OutputStats RetrieveOutputStats (string collectionId, string outputId)

Retrieve output statistics

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class RetrieveOutputStatsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 
            var outputId = "outputId_example";  // string | 

            try
            {
                // Retrieve output statistics
                OutputStats result = apiInstance.RetrieveOutputStats(collectionId, outputId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.RetrieveOutputStats: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RetrieveOutputStatsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve output statistics
    ApiResponse<OutputStats> response = apiInstance.RetrieveOutputStatsWithHttpInfo(collectionId, outputId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.RetrieveOutputStatsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
outputId	string

Return type

OutputStats

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

Status

OutputStatusResponse Status (string collectionId, string outputId)

Output status

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class StatusExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var collectionId = "collectionId_example";  // string | 
            var outputId = "outputId_example";  // string | 

            try
            {
                // Output status
                OutputStatusResponse result = apiInstance.Status(collectionId, outputId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.Status: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the StatusWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Output status
    ApiResponse<OutputStatusResponse> response = apiInstance.StatusWithHttpInfo(collectionId, outputId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.StatusWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
collectionId	string
outputId	string

Return type

OutputStatusResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

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

UpdateOutput

Output UpdateOutput (string existingCollectionId, string outputId, UpdateOutputBody body)

Update output

Example

using System.Collections.Generic;
using System.Diagnostics;
using Com.Lab5e.Span.Api;
using Com.Lab5e.Span.Client;
using Com.Lab5e.Span.Model;

namespace Example
{
    public class UpdateOutputExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.lab5e.com";
            // Configure API key authorization: APIToken
            config.AddApiKey("X-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Token", "Bearer");

            var apiInstance = new OutputsApi(config);
            var existingCollectionId = "existingCollectionId_example";  // string | 
            var outputId = "outputId_example";  // string | 
            var body = new UpdateOutputBody(); // UpdateOutputBody | 

            try
            {
                // Update output
                Output result = apiInstance.UpdateOutput(existingCollectionId, outputId, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling OutputsApi.UpdateOutput: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateOutputWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Update output
    ApiResponse<Output> response = apiInstance.UpdateOutputWithHttpInfo(existingCollectionId, outputId, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling OutputsApi.UpdateOutputWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
201	It's created.	-
400	The request has an error.	-
401	You can't touch this	-
404	Couldn't find the resource.	-
409	There's a resource conflict here.	-
500	I'm sorry. We are broken	-
0	An unexpected error response.	-

[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

Com.Lab5e.Span.Api.OutputsApi

CreateOutput

Example

Using the CreateOutputWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteOutput

Example

Using the DeleteOutputWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListOutputs

Example

Using the ListOutputsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Logs

Example

Using the LogsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RetrieveOutput

Example

Using the RetrieveOutputWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

RetrieveOutputStats

Example

Using the RetrieveOutputStatsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Status

Example

Using the StatusWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateOutput

Example

Using the UpdateOutputWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details