Skip to main content

WorkstreamSummary API

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

MethodHTTP requestDescription
workstreamSummariesSpecificWorkstreamSummarySnapshotGET /workstream_summary/{workstream_summary}/workstream_summary/{workstream_summary} [GET]
workstreamSummaryAssociateAnchorPOST /workstream_summary/{workstream_summary}/anchors/associate/{anchor}/workstream_summary/{workstream_summary}/anchors/associate/{anchor} [POST]
workstreamSummaryAssociateAssetPOST /workstream_summary/{workstream_summary}/assets/associate/{asset}/workstream_summary/{workstream_summary}/assets/associate/{asset} [POST]
workstreamSummaryAssociateConversationPOST /workstream_summary/{workstream_summary}/conversations/associate/{conversation}/workstream_summary/{workstream_summary}/conversations/associate/{conversation} [POST]
workstreamSummaryAssociatePersonPOST /workstream_summary/{workstream_summary}/persons/associate/{person}/workstream_summary/{workstream_summary}/persons/associate/{person} [POST]
workstreamSummaryAssociateRangePOST /workstream_summary/{workstream_summary}/ranges/associate/{range}/workstream_summary/{workstream_summary}/ranges/associate/{range} [POST]
workstreamSummaryAssociateWebsitePOST /workstream_summary/{workstream_summary}/websites/associate/{website}/workstream_summary/{workstream_summary}/websites/associate/{website} [POST]
workstreamSummaryAssociateWorkstreamEventPOST /workstream_summary/{workstream_summary}/workstream_events/associate/{workstream_event}/workstream_summary/{workstream_summary}/workstream_events/associate/{workstream_event} [POST]
workstreamSummaryDisassociateAnchorPOST /workstream_summary/{workstream_summary}/anchors/disassociate/{anchor}/workstream_summary/{workstream_summary}/anchors/disassociate/{anchor} [POST]
workstreamSummaryDisassociateAssetPOST /workstream_summary/{workstream_summary}/assets/disassociate/{asset}/workstream_summary/{workstream_summary}/assets/disassociate/{asset} [POST]
workstreamSummaryDisassociateConversationPOST /workstream_summary/{workstream_summary}/conversations/disassociate/{conversation}/workstream_summary/{workstream_summary}/conversations/disassociate/{conversation} [POST]
workstreamSummaryDisassociatePersonPOST /workstream_summary/{workstream_summary}/persons/disassociate/{person}/workstream_summary/{workstream_summary}/persons/disassociate/{person} [POST]
workstreamSummaryDisassociateRangePOST /workstream_summary/{workstream_summary}/ranges/disassociate/{range}/workstream_summary/{workstream_summary}/ranges/disassociate/{range} [POST]
workstreamSummaryDisassociateWebsitePOST /workstream_summary/{workstream_summary}/websites/disassociate/{website}/workstream_summary/{workstream_summary}/websites/disassociate/{website} [POST]
workstreamSummaryDisassociateWorkstreamEventPOST /workstream_summary/{workstream_summary}/workstream_events/disassociate/{workstream_event}/workstream_summary/{workstream_summary}/workstream_events/disassociate/{workstream_event} [POST]
workstreamSummaryScoresIncrementPOST /workstream_summary/{workstream_summary}/scores/increment'/workstream_summary/{workstream_summary}/scores/increment' [POST]
workstreamSummaryUpdatePOST /workstream_summary/update/workstream_summary/update [POST]

workstreamSummariesSpecificWorkstreamSummarySnapshot

WorkstreamSummary workstreamSummariesSpecificWorkstreamSummarySnapshot(workstreamSummary, transferables)

/workstream_summary/{workstream_summary} [GET]

This will get a snapshot of a single workstream_summary.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
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 : WorkstreamSummary = apiInstance.workstreamSummariesSpecificWorkstreamSummarySnapshot(workstreamSummary, transferables)
println(result)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummariesSpecificWorkstreamSummarySnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummariesSpecificWorkstreamSummarySnapshot")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
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

WorkstreamSummary

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociateAnchor

workstreamSummaryAssociateAnchor(workstreamSummary, anchor)

/workstream_summary/{workstream_summary}/anchors/associate/{anchor} [POST]

This will associate a anchor with a workstream_summary. This will do the same thing as the anchor equivalent.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val anchor : kotlin.String = anchor_example // kotlin.String | This is the specific uuid of an anchor.
try {
apiInstance.workstreamSummaryAssociateAnchor(workstreamSummary, anchor)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryAssociateAnchor")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryAssociateAnchor")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
anchorkotlin.StringThis is the specific uuid of an anchor.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociateAsset

workstreamSummaryAssociateAsset(workstreamSummary, asset)

/workstream_summary/{workstream_summary}/assets/associate/{asset} [POST]

This will associate an asset with a workstream_summary. This will do the same thing as the asset equivalent.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val asset : java.util.UUID = 2254f2c8-5797-40e8-ac56-41166dc0e159 // java.util.UUID | The id (uuid) of the asset that you are trying to access.
try {
apiInstance.workstreamSummaryAssociateAsset(workstreamSummary, asset)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryAssociateAsset")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryAssociateAsset")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
assetjava.util.UUIDThe id (uuid) of the asset that you are trying to access.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociateConversation

workstreamSummaryAssociateConversation(workstreamSummary, conversation)

/workstream_summary/{workstream_summary}/conversations/associate/{conversation} [POST]

This will associate an conversation with a workstream_summary. This will do the same thing as the conversation equivalent.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val conversation : kotlin.String = conversation_example // kotlin.String | This is the uuid of a conversation.
try {
apiInstance.workstreamSummaryAssociateConversation(workstreamSummary, conversation)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryAssociateConversation")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryAssociateConversation")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
conversationkotlin.StringThis is the uuid of a conversation.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociatePerson

workstreamSummaryAssociatePerson(workstreamSummary, person)

/workstream_summary/{workstream_summary}/persons/associate/{person} [POST]

This will associate an person with a workstream_summary. This will do the same thing as the person equivalent.

Example

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

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

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
personkotlin.StringThis is a uuid that represents a person.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociateRange

workstreamSummaryAssociateRange(workstreamSummary, range)

/workstream_summary/{workstream_summary}/ranges/associate/{range} [POST]

This will associate a range with a workstream_summary. This will do the same thing as the range equivalent.

Example

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

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

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociateWebsite

workstreamSummaryAssociateWebsite(workstreamSummary, website)

/workstream_summary/{workstream_summary}/websites/associate/{website} [POST]

This will associate a website with a workstream_summary. This will do the same thing as the website equivalent.

Example

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

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

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryAssociateWorkstreamEvent

workstreamSummaryAssociateWorkstreamEvent(workstreamSummary, workstreamEvent)

/workstream_summary/{workstream_summary}/workstream_events/associate/{workstream_event} [POST]

This will associate a workstream_summary with a workstream_event. This will do the same thing as the workstream_event equivalent.

Example

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

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

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
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

workstreamSummaryDisassociateAnchor

workstreamSummaryDisassociateAnchor(workstreamSummary, anchor)

/workstream_summary/{workstream_summary}/anchors/disassociate/{anchor} [POST]

This will enable us to disassociate a anchor from a workstream_summary. This will do the same thing as the anchor equivalent.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val anchor : kotlin.String = anchor_example // kotlin.String | This is the specific uuid of an anchor.
try {
apiInstance.workstreamSummaryDisassociateAnchor(workstreamSummary, anchor)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryDisassociateAnchor")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryDisassociateAnchor")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
anchorkotlin.StringThis is the specific uuid of an anchor.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryDisassociateAsset

workstreamSummaryDisassociateAsset(workstreamSummary, asset)

/workstream_summary/{workstream_summary}/assets/disassociate/{asset} [POST]

This will enable us to disassociate a asset from a workstream_summary. This will do the same thing as the asset equivalent.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val asset : java.util.UUID = 2254f2c8-5797-40e8-ac56-41166dc0e159 // java.util.UUID | The id (uuid) of the asset that you are trying to access.
try {
apiInstance.workstreamSummaryDisassociateAsset(workstreamSummary, asset)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryDisassociateAsset")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryDisassociateAsset")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
assetjava.util.UUIDThe id (uuid) of the asset that you are trying to access.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryDisassociateConversation

workstreamSummaryDisassociateConversation(workstreamSummary, conversation)

/workstream_summary/{workstream_summary}/conversations/disassociate/{conversation} [POST]

This will enable us to disassociate a conversation from a workstream_summary. This will do the same thing as the conversation equivalent.

Example

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

val apiInstance = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val conversation : kotlin.String = conversation_example // kotlin.String | This is the uuid of a conversation.
try {
apiInstance.workstreamSummaryDisassociateConversation(workstreamSummary, conversation)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryDisassociateConversation")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryDisassociateConversation")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
conversationkotlin.StringThis is the uuid of a conversation.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryDisassociatePerson

workstreamSummaryDisassociatePerson(workstreamSummary, person)

/workstream_summary/{workstream_summary}/persons/disassociate/{person} [POST]

This will enable us to disassociate a person from a workstream_summary. This will do the same thing as the person equivalent.

Example

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

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

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
personkotlin.StringThis is a uuid that represents a person.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryDisassociateRange

workstreamSummaryDisassociateRange(workstreamSummary, range)

/workstream_summary/{workstream_summary}/ranges/disassociate/{range} [POST]

This will enable us to disassociate a range from a workstream_summary. This will do the same thing as the range equivalent.

Example

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

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

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryDisassociateWebsite

workstreamSummaryDisassociateWebsite(workstreamSummary, website)

/workstream_summary/{workstream_summary}/websites/disassociate/{website} [POST]

This will enable us to disassociate a website from a workstream_summary. This will do the same thing as the website equivalent.

Example

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

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

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryDisassociateWorkstreamEvent

workstreamSummaryDisassociateWorkstreamEvent(workstreamSummary, workstreamEvent)

/workstream_summary/{workstream_summary}/workstream_events/disassociate/{workstream_event} [POST]

This will enable us to disassociate a workstream_summary from a workstream_event. This will do the same thing as the workstream_event equivalent.

Example

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

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

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
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

workstreamSummaryScoresIncrement

workstreamSummaryScoresIncrement(workstreamSummary, seededScoreIncrement)

'/workstream_summary/{workstream_summary}/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 = WorkstreamSummaryApi()
val workstreamSummary : kotlin.String = workstreamSummary_example // kotlin.String | This is a identifier that is used to identify a specific workstream_summary.
val seededScoreIncrement : SeededScoreIncrement = // SeededScoreIncrement |
try {
apiInstance.workstreamSummaryScoresIncrement(workstreamSummary, seededScoreIncrement)
} catch (e: ClientException) {
println("4xx response calling WorkstreamSummaryApi#workstreamSummaryScoresIncrement")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling WorkstreamSummaryApi#workstreamSummaryScoresIncrement")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
workstreamSummarykotlin.StringThis is a identifier that is used to identify a specific workstream_summary.
seededScoreIncrementSeededScoreIncrement[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

workstreamSummaryUpdate

WorkstreamSummary workstreamSummaryUpdate(transferables, workstreamSummary)

/workstream_summary/update [POST]

This will update a specific workstream_summary.

Example

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

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

Return type

WorkstreamSummary

Authorization

No authorization required

HTTP request headers

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