Skip to main content

WorkstreamEvents API

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

MethodHTTP requestDescription
workstreamEventsCreateNewWorkstreamEventPOST /workstream_events/create/workstream_events/create [POST]
workstreamEventsDeleteSpecificWorkstreamEventPOST /workstream_events/{workstream_event}/delete/workstream_events/{workstream_event}/delete [POST]
workstreamEventsSnapshotGET /workstream_events/workstream_events [GET]

workstreamEventsCreateNewWorkstreamEvent

WorkstreamEvent workstreamEventsCreateNewWorkstreamEvent(transferables, seededWorkstreamEvent)

/workstream_events/create [POST]

This will create a new WorkstreamEvent in the database.

Example

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

val apiInstance = WorkstreamEventsApi()
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 seededWorkstreamEvent : SeededWorkstreamEvent = // SeededWorkstreamEvent |
try {
val result : WorkstreamEvent = apiInstance.workstreamEventsCreateNewWorkstreamEvent(transferables, seededWorkstreamEvent)
println(result)
} catch (e: ClientException) {
println("4xx response calling WorkstreamEventsApi#workstreamEventsCreateNewWorkstreamEvent")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamEventsApi#workstreamEventsCreateNewWorkstreamEvent")
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]
seededWorkstreamEventSeededWorkstreamEvent[optional]

Return type

WorkstreamEvent

Authorization

No authorization required

HTTP request headers

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

workstreamEventsDeleteSpecificWorkstreamEvent

workstreamEventsDeleteSpecificWorkstreamEvent(workstreamEvent)

/workstream_events/{workstream_event}/delete [POST]

This will delete a specific workstream_event from the database!

Example

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

val apiInstance = WorkstreamEventsApi()
val workstreamEvent : kotlin.String = workstreamEvent_example // kotlin.String | This is a identifier that is used to identify a specific workstream_event.
try {
apiInstance.workstreamEventsDeleteSpecificWorkstreamEvent(workstreamEvent)
} catch (e: ClientException) {
println("4xx response calling WorkstreamEventsApi#workstreamEventsDeleteSpecificWorkstreamEvent")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamEventsApi#workstreamEventsDeleteSpecificWorkstreamEvent")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamEventkotlin.StringThis is a identifier that is used to identify a specific workstream_event.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamEventsSnapshot

WorkstreamEvents workstreamEventsSnapshot(transferables)

/workstream_events [GET]

This will get a snapshot of all your workstream events.

Example

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

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

WorkstreamEvents

Authorization

No authorization required

HTTP request headers

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