Skip to content

Latest commit

 

History

History
103 lines (73 loc) · 2.58 KB

APIAPI.md

File metadata and controls

103 lines (73 loc) · 2.58 KB

APIAPI

All URIs are relative to https://api.lamp.digital

Method HTTP request Description
aPIQuery POST / Query the LAMP Database.
aPISchema GET / View the API schema document.

aPIQuery

kotlin.Any aPIQuery(body)

Query the LAMP Database.

Query the LAMP Database using a transformation document. All GET operations in this API schema document are available by replacing the period with an underscore (i.e. `$Participant_view(...)` instead of `Participant.view(...)`). The `origin`, `from`, and `to` parameters of EventStream functions are preserved but the `transform` parameter is not.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = APIAPI()
val body : kotlin.String = body_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.aPIQuery(body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling APIAPI#aPIQuery")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling APIAPI#aPIQuery")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
body kotlin.String

Return type

kotlin.Any

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: text/plain, application/json
  • Accept: application/json

aPISchema

kotlin.Any aPISchema()

View the API schema document.

View this API schema document from a live server instance.

Example

// Import classes:
//import digital.lamp.lamp-core.infrastructure.*
//import digital.lamp.lamp-core.models.*

val apiInstance = APIAPI()
try {
    val result : kotlin.Any = apiInstance.aPISchema()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling APIAPI#aPISchema")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling APIAPI#aPISchema")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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