Skip to content
This repository has been archived by the owner on Jan 12, 2023. It is now read-only.

Latest commit

 

History

History
248 lines (145 loc) · 6.25 KB

OutputsApi.md

File metadata and controls

248 lines (145 loc) · 6.25 KB
Raw

\OutputsApi

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

Method HTTP request Description
CreateOutput Post /collections/{collectionId}/outputs Create output
DeleteOutput Delete /collections/{collectionId}/outputs/{outputId} Delete output
ListOutputs Get /collections/{collectionId}/outputs List outputs
Logs Get /collections/{collectionId}/outputs/{outputId}/logs Output logs
RetrieveOutput Get /collections/{collectionId}/outputs/{outputId} Retrieve output
Status Get /collections/{collectionId}/outputs/{outputId}/status Output status
UpdateOutput Patch /collections/{collectionId}/outputs/{outputId} Update output

CreateOutput

Output CreateOutput(ctx, collectionId, body)

Create output

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId string
body Output

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

Delete output

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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(ctx, collectionId)

List outputs

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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

OutputLogs Logs(ctx, collectionId, outputId)

Output logs

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId string
outputId string

Return type

OutputLogs

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

Retrieve output

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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]

Status

OutputStatus Status(ctx, collectionId, outputId)

Output status

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId string
outputId string

Return type

OutputStatus

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

Update output

Running outputs will be restarted if required. Note that the collection ID can't be changed on an existing output.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId string
outputId string
body Output

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]