Skip to main content

Linkify API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
linkifyPOST /linkify/linkify [POST]
linkifyMultiplePOST /linkify/multiple/linkify/multiple [POST]
linkifyShareRevokePOST /linkify/{share}/revoke[POST} /linkify/{share}/revoke

linkify

Shares linkify(linkify)

/linkify [POST]

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = LinkifyApi()
val linkify : Linkify = // Linkify |
try {
val result : Shares = apiInstance.linkify(linkify)
println(result)
} catch (e: ClientException) {
println("4xx response calling LinkifyApi#linkify")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling LinkifyApi#linkify")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
linkifyLinkify[optional]

Return type

Shares

Authorization

No authorization required

HTTP request headers

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

linkifyMultiple

Shares linkifyMultiple(linkifyMultiple)

/linkify/multiple [POST]

  • assumption that you have already backed up the asset's that you are sending to this endpoint.(b/c the assets are ids.)

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = LinkifyApi()
val linkifyMultiple : LinkifyMultiple = // LinkifyMultiple |
try {
val result : Shares = apiInstance.linkifyMultiple(linkifyMultiple)
println(result)
} catch (e: ClientException) {
println("4xx response calling LinkifyApi#linkifyMultiple")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling LinkifyApi#linkifyMultiple")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
linkifyMultipleLinkifyMultiple[optional]

Return type

Shares

Authorization

No authorization required

HTTP request headers

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

linkifyShareRevoke

kotlin.String linkifyShareRevoke(share)

[POST} /linkify/{share}/revoke

This will revoke a link.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = LinkifyApi()
val share : kotlin.String = share_example // kotlin.String |
try {
val result : kotlin.String = apiInstance.linkifyShareRevoke(share)
println(result)
} catch (e: ClientException) {
println("4xx response calling LinkifyApi#linkifyShareRevoke")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling LinkifyApi#linkifyShareRevoke")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
sharekotlin.String

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined