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

Create output

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    CreateOutputBody body = new CreateOutputBody(); // CreateOutputBody | 
    try {
      Output result = apiInstance.createOutput(collectionId, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#createOutput");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

deleteOutput

Output deleteOutput(collectionId, outputId)

Delete output

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    String outputId = "outputId_example"; // String | 
    try {
      Output result = apiInstance.deleteOutput(collectionId, outputId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#deleteOutput");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

listOutputs

ListOutputResponse listOutputs(collectionId)

List outputs

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    try {
      ListOutputResponse result = apiInstance.listOutputs(collectionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#listOutputs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

logs

OutputLogResponse logs(collectionId, outputId)

Output logs

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    String outputId = "outputId_example"; // String | 
    try {
      OutputLogResponse result = apiInstance.logs(collectionId, outputId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#logs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

retrieveOutput

Output retrieveOutput(collectionId, outputId)

Retrieve output

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    String outputId = "outputId_example"; // String | 
    try {
      Output result = apiInstance.retrieveOutput(collectionId, outputId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#retrieveOutput");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

retrieveOutputStats

OutputStats retrieveOutputStats(collectionId, outputId)

Retrieve output statistics

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    String outputId = "outputId_example"; // String | 
    try {
      OutputStats result = apiInstance.retrieveOutputStats(collectionId, outputId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#retrieveOutputStats");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

status

OutputStatusResponse status(collectionId, outputId)

Output status

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String collectionId = "collectionId_example"; // String | 
    String outputId = "outputId_example"; // String | 
    try {
      OutputStatusResponse result = apiInstance.status(collectionId, outputId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#status");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

updateOutput

Output updateOutput(existingCollectionId, outputId, body)

Update output

Example

// Import classes:
import com.lab5e.ApiClient;
import com.lab5e.ApiException;
import com.lab5e.Configuration;
import com.lab5e.auth.*;
import com.lab5e.models.*;
import com.lab5e.span.OutputsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lab5e.com");
    
    // Configure API key authorization: APIToken
    ApiKeyAuth APIToken = (ApiKeyAuth) defaultClient.getAuthentication("APIToken");
    APIToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIToken.setApiKeyPrefix("Token");

    OutputsApi apiInstance = new OutputsApi(defaultClient);
    String existingCollectionId = "existingCollectionId_example"; // String | 
    String outputId = "outputId_example"; // String | 
    UpdateOutputBody body = new UpdateOutputBody(); // UpdateOutputBody | 
    try {
      Output result = apiInstance.updateOutput(existingCollectionId, outputId, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OutputsApi#updateOutput");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.	-

Files

OutputsApi.md

Latest commit

History

OutputsApi.md

File metadata and controls

OutputsApi

createOutput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteOutput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listOutputs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

logs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieveOutput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieveOutputStats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateOutput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details