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()

This will get a snapshot of a single workstream_summary.

Example

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

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

const body: Pieces.WorkstreamSummariesSpecificWorkstreamSummarySnapshotRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_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.workstreamSummariesSpecificWorkstreamSummarySnapshot(body).then((data: WorkstreamSummary) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.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

WorkstreamSummary

HTTP request headers

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

HTTP response details

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

workstreamSummaryAssociateAnchor

workstreamSummaryAssociateAnchor()

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

Example

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

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

const body: Pieces.WorkstreamSummaryAssociateAnchorRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is the specific uuid of an anchor.
anchor: anchor_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
anchor[string]This is the specific uuid of an anchor.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-

workstreamSummaryAssociateAsset

workstreamSummaryAssociateAsset()

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

Example

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

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

const body: Pieces.WorkstreamSummaryAssociateAssetRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | The id (uuid) of the asset that you are trying to access.
asset: 2254f2c8-5797-40e8-ac56-41166dc0e159,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
asset[string]The id (uuid) of the asset that you are trying to access.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-

workstreamSummaryAssociateConversation

workstreamSummaryAssociateConversation()

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

Example

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

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

const body: Pieces.WorkstreamSummaryAssociateConversationRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is the uuid of a conversation.
conversation: conversation_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
conversation[string]This is the uuid of a conversation.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-

workstreamSummaryAssociatePerson

workstreamSummaryAssociatePerson()

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

Example

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

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

const body: Pieces.WorkstreamSummaryAssociatePersonRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is a uuid that represents a person.
person: person_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
person[string]This is a uuid that represents a person.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-

workstreamSummaryAssociateRange

workstreamSummaryAssociateRange()

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

Example

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

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

const body: Pieces.WorkstreamSummaryAssociateRangeRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is a identifier that is used to identify a specific range.
range: range_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
range[string]This is a identifier that is used to identify a specific range.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-

workstreamSummaryAssociateWebsite

workstreamSummaryAssociateWebsite()

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

Example

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

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

const body: Pieces.WorkstreamSummaryAssociateWebsiteRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | website id
website: website_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
website[string]website iddefaults 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-

workstreamSummaryAssociateWorkstreamEvent

workstreamSummaryAssociateWorkstreamEvent()

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

Example

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

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

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

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
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: Not defined
  • Accept: text/plain

HTTP response details

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

workstreamSummaryDisassociateAnchor

workstreamSummaryDisassociateAnchor()

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

Example

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

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

const body: Pieces.WorkstreamSummaryDisassociateAnchorRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is the specific uuid of an anchor.
anchor: anchor_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
anchor[string]This is the specific uuid of an anchor.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-

workstreamSummaryDisassociateAsset

workstreamSummaryDisassociateAsset()

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

Example

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

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

const body: Pieces.WorkstreamSummaryDisassociateAssetRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | The id (uuid) of the asset that you are trying to access.
asset: 2254f2c8-5797-40e8-ac56-41166dc0e159,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
asset[string]The id (uuid) of the asset that you are trying to access.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-

workstreamSummaryDisassociateConversation

workstreamSummaryDisassociateConversation()

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

Example

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

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

const body: Pieces.WorkstreamSummaryDisassociateConversationRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is the uuid of a conversation.
conversation: conversation_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
conversation[string]This is the uuid of a conversation.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-

workstreamSummaryDisassociatePerson

workstreamSummaryDisassociatePerson()

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

Example

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

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

const body: Pieces.WorkstreamSummaryDisassociatePersonRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is a uuid that represents a person.
person: person_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
person[string]This is a uuid that represents a person.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-

workstreamSummaryDisassociateRange

workstreamSummaryDisassociateRange()

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

Example

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

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

const body: Pieces.WorkstreamSummaryDisassociateRangeRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | This is a identifier that is used to identify a specific range.
range: range_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
range[string]This is a identifier that is used to identify a specific range.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-

workstreamSummaryDisassociateWebsite

workstreamSummaryDisassociateWebsite()

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

Example

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

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

const body: Pieces.WorkstreamSummaryDisassociateWebsiteRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// string | website id
website: website_example,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
website[string]website iddefaults 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-

workstreamSummaryDisassociateWorkstreamEvent

workstreamSummaryDisassociateWorkstreamEvent()

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 * as Pieces from '@pieces.app/pieces-os-client'

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

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

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

Parameters

NameTypeDescriptionNotes
workstreamSummary[string]This is a identifier that is used to identify a specific workstream_summary.defaults to undefined
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: Not defined
  • Accept: text/plain

HTTP response details

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

workstreamSummaryScoresIncrement

workstreamSummaryScoresIncrement()

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.WorkstreamSummaryApi(configuration)

const body: Pieces.WorkstreamSummaryScoresIncrementRequest = {
// string | This is a identifier that is used to identify a specific workstream_summary.
workstreamSummary: workstreamSummary_example,
// SeededScoreIncrement (optional)
seededScoreIncrement: ,
};

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

Parameters

NameTypeDescriptionNotes
seededScoreIncrementSeededScoreIncrement
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: application/json
  • Accept: text/plain

HTTP response details

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

workstreamSummaryUpdate

WorkstreamSummary workstreamSummaryUpdate()

This will update a specific workstream_summary.

Example

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

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

const body: Pieces.WorkstreamSummaryUpdateRequest = {
// 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,
// WorkstreamSummary (optional)
workstreamSummary: ,
};

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

Parameters

NameTypeDescriptionNotes
workstreamSummaryWorkstreamSummary
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

WorkstreamSummary

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-