Skip to main content

Formats API

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

MethodHTTP requestDescription
formatsSnapshotGET /formats/formats [GET] Scoped to Formats
formatsSpecificFormatSnapshotGET /formats/{format}/formats/{format} [GET] Scoped to Formats

formatsSnapshot

Formats formatsSnapshot(transferables)

/formats [GET] Scoped to Formats

Get all of your formats for a given user.

Example

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

val apiInstance = FormatsApi()
val transferables : kotlin.Boolean = true // kotlin.Boolean | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
try {
val result : Formats = apiInstance.formatsSnapshot(transferables)
println(result)
} catch (e: ClientException) {
println("4xx response calling FormatsApi#formatsSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FormatsApi#formatsSnapshot")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
transferableskotlin.BooleanThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]

Return type

Formats

Authorization

No authorization required

HTTP request headers

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

formatsSpecificFormatSnapshot

Format formatsSpecificFormatSnapshot(format, transferable)

/formats/{format} [GET] Scoped to Formats

Request a specific format when given a id (uuid in path params)

Example

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

val apiInstance = FormatsApi()
val format : java.util.UUID = 102ff265-fdfb-4142-8d94-4932d400199c // java.util.UUID | The id (uuid) for a specific format.
val transferable : kotlin.Boolean = true // kotlin.Boolean | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)
try {
val result : Format = apiInstance.formatsSpecificFormatSnapshot(format, transferable)
println(result)
} catch (e: ClientException) {
println("4xx response calling FormatsApi#formatsSpecificFormatSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling FormatsApi#formatsSpecificFormatSnapshot")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
formatjava.util.UUIDThe id (uuid) for a specific format.
transferablekotlin.BooleanThis is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)[optional]

Return type

Format

Authorization

No authorization required

HTTP request headers

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