Skip to content

Latest commit

 

History

History
248 lines (140 loc) · 6.94 KB

OutputsApi.md

File metadata and controls

248 lines (140 loc) · 6.94 KB

\OutputsApi

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

Method HTTP request Description
create_output POST /span/collections/{collectionId}/outputs Create output
delete_output DELETE /span/collections/{collectionId}/outputs/{outputId} Delete output
list_outputs GET /span/collections/{collectionId}/outputs List outputs
logs GET /span/collections/{collectionId}/outputs/{outputId}/logs Output logs
retrieve_output GET /span/collections/{collectionId}/outputs/{outputId} Retrieve output
retrieve_output_stats GET /span/collections/{collectionId}/outputs/{outputId}/stats Retrieve output statistics
status GET /span/collections/{collectionId}/outputs/{outputId}/status Output status
update_output PATCH /span/collections/{existingCollectionId}/outputs/{outputId} Update output

create_output

crate::models::Output create_output(collection_id, body) Create output

Parameters

Name Type Description Required Notes
collection_id String [required]
body CreateOutputBody [required]

Return type

crate::models::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]

delete_output

crate::models::Output delete_output(collection_id, output_id) Delete output

Parameters

Name Type Description Required Notes
collection_id String [required]
output_id String [required]

Return type

crate::models::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]

list_outputs

crate::models::ListOutputResponse list_outputs(collection_id) List outputs

Parameters

Name Type Description Required Notes
collection_id String [required]

Return type

crate::models::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

crate::models::OutputLogResponse logs(collection_id, output_id) Output logs

Parameters

Name Type Description Required Notes
collection_id String [required]
output_id String [required]

Return type

crate::models::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]

retrieve_output

crate::models::Output retrieve_output(collection_id, output_id) Retrieve output

Parameters

Name Type Description Required Notes
collection_id String [required]
output_id String [required]

Return type

crate::models::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]

retrieve_output_stats

crate::models::OutputStats retrieve_output_stats(collection_id, output_id) Retrieve output statistics

Parameters

Name Type Description Required Notes
collection_id String [required]
output_id String [required]

Return type

crate::models::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

crate::models::OutputStatusResponse status(collection_id, output_id) Output status

Parameters

Name Type Description Required Notes
collection_id String [required]
output_id String [required]

Return type

crate::models::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]

update_output

crate::models::Output update_output(existing_collection_id, output_id, body) Update output

Parameters

Name Type Description Required Notes
existing_collection_id String [required]
output_id String [required]
body UpdateOutputBody [required]

Return type

crate::models::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]