Skip to main content

AnchorPoints API

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

MethodHTTP requestDescription
anchorPointsCreateNewAnchorPointPOST /anchor_points/create/anchor_points/create [POST]
anchorPointsDeleteSpecificAnchorPointPOST /anchor_points/{anchor_point}/delete/anchor_points/{anchor_point}/delete [POST]
anchorPointsSnapshotGET /anchor_points/anchor_points [GET]

anchorPointsCreateNewAnchorPoint

AnchorPoint anchorPointsCreateNewAnchorPoint(transferables, seededAnchorPoint)

/anchor_points/create [POST]

This will create a anchorPoint.

Example

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

val apiInstance = AnchorPointsApi()
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)
val seededAnchorPoint : SeededAnchorPoint = // SeededAnchorPoint |
try {
val result : AnchorPoint = apiInstance.anchorPointsCreateNewAnchorPoint(transferables, seededAnchorPoint)
println(result)
} catch (e: ClientException) {
println("4xx response calling AnchorPointsApi#anchorPointsCreateNewAnchorPoint")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AnchorPointsApi#anchorPointsCreateNewAnchorPoint")
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]
seededAnchorPointSeededAnchorPoint[optional]

Return type

AnchorPoint

Authorization

No authorization required

HTTP request headers

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

anchorPointsDeleteSpecificAnchorPoint

anchorPointsDeleteSpecificAnchorPoint(anchorPoint)

/anchor_points/{anchor_point}/delete [POST]

This will delete a specific anchorPoint!

Example

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

val apiInstance = AnchorPointsApi()
val anchorPoint : kotlin.String = anchorPoint_example // kotlin.String | This is the specific uuid of an anchor_point.
try {
apiInstance.anchorPointsDeleteSpecificAnchorPoint(anchorPoint)
} catch (e: ClientException) {
println("4xx response calling AnchorPointsApi#anchorPointsDeleteSpecificAnchorPoint")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AnchorPointsApi#anchorPointsDeleteSpecificAnchorPoint")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
anchorPointkotlin.StringThis is the specific uuid of an anchor_point.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

anchorPointsSnapshot

AnchorPoints anchorPointsSnapshot(transferables)

/anchor_points [GET]

This will get a snapshot of all your anchorPoints.

Example

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

val apiInstance = AnchorPointsApi()
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 : AnchorPoints = apiInstance.anchorPointsSnapshot(transferables)
println(result)
} catch (e: ClientException) {
println("4xx response calling AnchorPointsApi#anchorPointsSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AnchorPointsApi#anchorPointsSnapshot")
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

AnchorPoints

Authorization

No authorization required

HTTP request headers

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