Skip to main content

AnchorPoint API

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

MethodHTTP requestDescription
anchorPointScoresIncrementPOST /anchor_point/{anchor_point}/scores/increment'/anchor_point/{anchor_point}/scores/increment' [POST]
anchorPointSpecificAnchorPointSnapshotGET /anchor_point/{anchor_point}/anchor_point/{anchor_point} [GET]
anchorPointUpdatePOST /anchor_point/update/anchor_point/update [POST]

anchorPointScoresIncrement

anchorPointScoresIncrement(anchorPoint, seededScoreIncrement)

'/anchor_point/{anchor_point}/scores/increment' [POST]

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

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

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

Parameters

NameTypeDescriptionNotes
anchorPointkotlin.StringThis is the specific uuid of an anchor_point.
seededScoreIncrementSeededScoreIncrement[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

anchorPointSpecificAnchorPointSnapshot

AnchorPoint anchorPointSpecificAnchorPointSnapshot(anchorPoint, transferables)

/anchor_point/{anchor_point} [GET]

This will get a snapshot of a single anchorPoint.

Example

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

val apiInstance = AnchorPointApi()
val anchorPoint : kotlin.String = anchorPoint_example // kotlin.String | This is the specific uuid of an anchor_point.
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 : AnchorPoint = apiInstance.anchorPointSpecificAnchorPointSnapshot(anchorPoint, transferables)
println(result)
} catch (e: ClientException) {
println("4xx response calling AnchorPointApi#anchorPointSpecificAnchorPointSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling AnchorPointApi#anchorPointSpecificAnchorPointSnapshot")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
anchorPointkotlin.StringThis is the specific uuid of an anchor_point.
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

AnchorPoint

Authorization

No authorization required

HTTP request headers

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

anchorPointUpdate

AnchorPoint anchorPointUpdate(transferables, anchorPoint)

/anchor_point/update [POST]

This will update a specific anchorPoint.

Example

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

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

Return type

AnchorPoint

Authorization

No authorization required

HTTP request headers

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