Skip to main content

Relationships API

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

MethodHTTP requestDescription
relationshipsSnapshotGET /relationships/relationships [GET]

relationshipsSnapshot

Relationships relationshipsSnapshot()

/relationships [GET]

This will return all of the relationships that exists within your pieces db.

Example

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

val apiInstance = RelationshipsApi()
try {
val result : Relationships = apiInstance.relationshipsSnapshot()
println(result)
} catch (e: ClientException) {
println("4xx response calling RelationshipsApi#relationshipsSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling RelationshipsApi#relationshipsSnapshot")
e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

Relationships

Authorization

No authorization required

HTTP request headers

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