Skip to content

Latest commit

 

History

History
416 lines (292 loc) · 12.5 KB

OutputsAPI.md

File metadata and controls

416 lines (292 loc) · 12.5 KB
Raw

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

    open class func createOutput(collectionId: String, body: CreateOutputBody, completion: @escaping (_ data: Output?, _ error: Error?) -> Void)

Create output

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 
let body = CreateOutputBody(type: OutputType(), config: OutputConfig(url: "url_example", basicAuthUser: "basicAuthUser_example", basicAuthPass: "basicAuthPass_example", customHeaderName: "customHeaderName_example", customHeaderValue: "customHeaderValue_example", host: "host_example", port: 123, key: "key_example", eventName: "eventName_example", asIsPayload: false, endpoint: "endpoint_example", disableCertCheck: false, username: "username_example", password: "password_example", clientId: "clientId_example", topicName: "topicName_example", topicTemplate: 123, payloadFormat: "payloadFormat_example", payloadTemplate: 123), enabled: false, tags: "TODO") // CreateOutputBody | 

// Create output
OutputsAPI.createOutput(collectionId: collectionId, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func deleteOutput(collectionId: String, outputId: String, completion: @escaping (_ data: Output?, _ error: Error?) -> Void)

Delete output

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 
let outputId = "outputId_example" // String | 

// Delete output
OutputsAPI.deleteOutput(collectionId: collectionId, outputId: outputId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func listOutputs(collectionId: String, completion: @escaping (_ data: ListOutputResponse?, _ error: Error?) -> Void)

List outputs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 

// List outputs
OutputsAPI.listOutputs(collectionId: collectionId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func logs(collectionId: String, outputId: String, completion: @escaping (_ data: OutputLogResponse?, _ error: Error?) -> Void)

Output logs

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 
let outputId = "outputId_example" // String | 

// Output logs
OutputsAPI.logs(collectionId: collectionId, outputId: outputId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func retrieveOutput(collectionId: String, outputId: String, completion: @escaping (_ data: Output?, _ error: Error?) -> Void)

Retrieve output

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 
let outputId = "outputId_example" // String | 

// Retrieve output
OutputsAPI.retrieveOutput(collectionId: collectionId, outputId: outputId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func retrieveOutputStats(collectionId: String, outputId: String, completion: @escaping (_ data: OutputStats?, _ error: Error?) -> Void)

Retrieve output statistics

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 
let outputId = "outputId_example" // String | 

// Retrieve output statistics
OutputsAPI.retrieveOutputStats(collectionId: collectionId, outputId: outputId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func status(collectionId: String, outputId: String, completion: @escaping (_ data: OutputStatusResponse?, _ error: Error?) -> Void)

Output status

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let collectionId = "collectionId_example" // String | 
let outputId = "outputId_example" // String | 

// Output status
OutputsAPI.status(collectionId: collectionId, outputId: outputId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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

    open class func updateOutput(existingCollectionId: String, outputId: String, body: UpdateOutputBody, completion: @escaping (_ data: Output?, _ error: Error?) -> Void)

Update output

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Span

let existingCollectionId = "existingCollectionId_example" // String | 
let outputId = "outputId_example" // String | 
let body = UpdateOutputBody(collectionId: "collectionId_example", type: OutputType(), config: OutputConfig(url: "url_example", basicAuthUser: "basicAuthUser_example", basicAuthPass: "basicAuthPass_example", customHeaderName: "customHeaderName_example", customHeaderValue: "customHeaderValue_example", host: "host_example", port: 123, key: "key_example", eventName: "eventName_example", asIsPayload: false, endpoint: "endpoint_example", disableCertCheck: false, username: "username_example", password: "password_example", clientId: "clientId_example", topicName: "topicName_example", topicTemplate: 123, payloadFormat: "payloadFormat_example", payloadTemplate: 123), enabled: false, tags: "TODO") // UpdateOutputBody | 

// Update output
OutputsAPI.updateOutput(existingCollectionId: existingCollectionId, outputId: outputId, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

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]