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

This will create a new WorkstreamSummary in the database.

Example

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

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

const body: Pieces.WorkstreamSummariesCreateNewWorkstreamSummaryRequest = {
// 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,
// SeededWorkstreamSummary (optional)
seededWorkstreamSummary: ,
};

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

Parameters

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

workstreamSummariesDeleteSpecificWorkstreamSummary

workstreamSummariesDeleteSpecificWorkstreamSummary()

This will delete a specific workstream_summary from the database!

Example

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

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

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

apiInstance.workstreamSummariesDeleteSpecificWorkstreamSummary(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

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-

workstreamSummariesSnapshot

WorkstreamSummaries workstreamSummariesSnapshot()

This will get a snapshot of all your workstream summaries.

Example

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

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

const body: Pieces.WorkstreamSummariesSnapshotRequest = {
// 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.workstreamSummariesSnapshot(body).then((data: WorkstreamSummaries) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
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

WorkstreamSummaries

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-