Skip to main content

WorkstreamSummaries API

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

MethodHTTP requestDescription
workstreamSummariesCreateNewWorkstreamSummaryPOST /workstream_summaries/create/workstream_summaries/create [POST]
workstreamSummariesDeleteSpecificWorkstreamSummaryPOST /workstream_summaries/{workstream_summary}/delete/workstream_summaries/{workstream_summary}/delete [POST]
workstreamSummariesSnapshotGET /workstream_summaries/workstream_summaries [GET]

workstreamSummariesCreateNewWorkstreamSummary

WorkstreamSummary workstreamSummariesCreateNewWorkstreamSummary(transferables, seededWorkstreamSummary)

/workstream_summaries/create [POST]

This will create a new WorkstreamSummary in the database.

Example

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

val apiInstance = WorkstreamSummariesApi()
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 seededWorkstreamSummary : SeededWorkstreamSummary = // SeededWorkstreamSummary |
try {
val result : WorkstreamSummary = apiInstance.workstreamSummariesCreateNewWorkstreamSummary(transferables, seededWorkstreamSummary)
println(result)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummariesApi#workstreamSummariesCreateNewWorkstreamSummary")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummariesApi#workstreamSummariesCreateNewWorkstreamSummary")
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]
seededWorkstreamSummarySeededWorkstreamSummary[optional]

Return type

WorkstreamSummary

Authorization

No authorization required

HTTP request headers

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

workstreamSummariesDeleteSpecificWorkstreamSummary

workstreamSummariesDeleteSpecificWorkstreamSummary(workstreamSummary)

/workstream_summaries/{workstream_summary}/delete [POST]

This will delete a specific workstream_summary from the database!

Example

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

val apiInstance = WorkstreamSummariesApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
try {
apiInstance.workstreamSummariesDeleteSpecificWorkstreamSummary(workstreamSummary)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummariesApi#workstreamSummariesDeleteSpecificWorkstreamSummary")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummariesApi#workstreamSummariesDeleteSpecificWorkstreamSummary")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummariesSnapshot

WorkstreamSummaries workstreamSummariesSnapshot(transferables)

/workstream_summaries [GET]

This will get a snapshot of all your workstream summaries.

Example

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

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

WorkstreamSummaries

Authorization

No authorization required

HTTP request headers

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