Skip to main content

WorkstreamEvent API

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

MethodHTTP requestDescription
workstreamEventAssociateWorkstreamSummaryPOST /workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary}/workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary} [POST]
workstreamEventDisassociateWorkstreamSummaryPOST /workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary}/workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary} [POST]
workstreamEventScoresIncrementPOST /workstream_event/{workstream_event}/scores/increment'/workstream_event/{workstream_event}/scores/increment' [POST]
workstreamEventUpdatePOST /workstream_event/update/workstream_event/update [POST]
workstreamEventsSpecificWorkstreamEventSnapshotGET /workstream_event/{workstream_event}/workstream_event/{workstream_event} [GET]

workstreamEventAssociateWorkstreamSummary

workstreamEventAssociateWorkstreamSummary()

This will associate a workstream_event with a workstream summary. This will do the same thing as the workstreamSummary equivalent.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.WorkstreamEventApi(configuration)

const body: Pieces.WorkstreamEventAssociateWorkstreamSummaryRequest = {
// string | This is a identifier that is used to identify a specific workstream_event.
workstreamEvent: workstreamEvent_example,
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
};

apiInstance.workstreamEventAssociateWorkstreamSummary(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
workstreamEvent[string]This is a identifier that is used to identify a specific workstream_event.defaults to undefined
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

workstreamEventDisassociateWorkstreamSummary

workstreamEventDisassociateWorkstreamSummary()

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

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.WorkstreamEventApi(configuration)

const body: Pieces.WorkstreamEventDisassociateWorkstreamSummaryRequest = {
// string | This is a identifier that is used to identify a specific workstream_event.
workstreamEvent: workstreamEvent_example,
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
};

apiInstance.workstreamEventDisassociateWorkstreamSummary(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
workstreamEvent[string]This is a identifier that is used to identify a specific workstream_event.defaults to undefined
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

workstreamEventScoresIncrement

workstreamEventScoresIncrement()

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.WorkstreamEventApi(configuration)

const body: Pieces.WorkstreamEventScoresIncrementRequest = {
// string | This is a identifier that is used to identify a specific workstream_event.
workstreamEvent: workstreamEvent_example,
// SeededScoreIncrement (optional)
seededScoreIncrement: ,
};

apiInstance.workstreamEventScoresIncrement(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededScoreIncrementSeededScoreIncrement
workstreamEvent[string]This is a identifier that is used to identify a specific workstream_event.defaults to undefined

Return type

void (empty response body)

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

workstreamEventUpdate

WorkstreamEvent workstreamEventUpdate()

This will update a specific workstream_event.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.WorkstreamEventApi(configuration)

const body: Pieces.WorkstreamEventUpdateRequest = {
// boolean | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
transferables: true,
// WorkstreamEvent (optional)
workstreamEvent: ,
};

apiInstance.workstreamEventUpdate(body).then((data: WorkstreamEvent) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
workstreamEventWorkstreamEvent
transferables[boolean]This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)(optional) defaults to undefined

Return type

WorkstreamEvent

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

workstreamEventsSpecificWorkstreamEventSnapshot

WorkstreamEvent workstreamEventsSpecificWorkstreamEventSnapshot()

This will get a snapshot of a single workstream_event.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.WorkstreamEventApi(configuration)

const body: Pieces.WorkstreamEventsSpecificWorkstreamEventSnapshotRequest = {
// string | This is a identifier that is used to identify a specific workstream_event.
workstreamEvent: workstreamEvent_example,
// boolean | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
transferables: true,
};

apiInstance.workstreamEventsSpecificWorkstreamEventSnapshot(body).then((data: WorkstreamEvent) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
workstreamEvent[string]This is a identifier that is used to identify a specific workstream_event.defaults to undefined
transferables[boolean]This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)(optional) defaults to undefined

Return type

WorkstreamEvent

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
410WorkstreamEvent not found.-