Skip to main content

Website API

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

MethodHTTP requestDescription
websiteAssociateAssetPOST /website/{website}/assets/associate/{asset}/website/{website}/assets/associate/{asset} [POST]
websiteAssociateConversationPOST /website/{website}/conversations/associate/{conversation}/website/{website}/conversations/associate/{conversation} [POST]
websiteAssociatePersonPOST /website/{website}/persons/associate/{person}/website/{website}/persons/associate/{person} [POST]
websiteAssociateWorkstreamSummaryPOST /website/{website}/workstream_summaries/associate/{workstream_summary}/website/{website}/workstream_summaries/associate/{workstream_summary} [POST]
websiteDisassociateAssetPOST /website/{website}/assets/disassociate/{asset}/website/{website}/assets/disassociate/{asset} [POST]
websiteDisassociateConversationPOST /website/{website}/conversations/disassociate/{conversation}/website/{website}/conversations/disassociate/{conversation} [POST]
websiteDisassociatePersonPOST /website/{website}/persons/disassociate/{person}/website/{website}/persons/disassociate/{person} [POST]
websiteDisassociateWorkstreamSummaryPOST /website/{website}/workstream_summaries/disassociate/{workstream_summary}/website/{website}/workstream_summaries/disassociate/{workstream_summary} [POST]
websiteScoresIncrementPOST /website/{website}/scores/increment'/website/{website}/scores/increment' [POST]
websiteUpdatePOST /website/update/website/update [POST]
websitesSpecificWebsiteSnapshotGET /website/{website}/website/{website} [GET]

websiteAssociateAsset

websiteAssociateAsset()

This will associate a website with a asset.

Example

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

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

const body: Pieces.WebsiteAssociateAssetRequest = {
// string | The id (uuid) of the asset that you are trying to access.
asset: 2254f2c8-5797-40e8-ac56-41166dc0e159,
// string | website id
website: website_example,
};

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

Parameters

NameTypeDescriptionNotes
asset[string]The id (uuid) of the asset that you are trying to access.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-

websiteAssociateConversation

websiteAssociateConversation()

This will associate a website with a conversation.

Example

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

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

const body: Pieces.WebsiteAssociateConversationRequest = {
// string | website id
website: website_example,
// string | This is the uuid of a conversation.
conversation: conversation_example,
};

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteAssociatePerson

websiteAssociatePerson()

This will associate a website with a person.

Example

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

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

const body: Pieces.WebsiteAssociatePersonRequest = {
// string | website id
website: website_example,
// string | This is a uuid that represents a person.
person: person_example,
};

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteAssociateWorkstreamSummary

websiteAssociateWorkstreamSummary()

This will associate a website 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.WebsiteApi(configuration)

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

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteDisassociateAsset

websiteDisassociateAsset()

This will enable us to dissassociate a website from a asset.

Example

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

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

const body: Pieces.WebsiteDisassociateAssetRequest = {
// string | website id
website: website_example,
// string | The id (uuid) of the asset that you are trying to access.
asset: 2254f2c8-5797-40e8-ac56-41166dc0e159,
};

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteDisassociateConversation

websiteDisassociateConversation()

This will enable us to dissassociate a website from a conversation.

Example

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

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

const body: Pieces.WebsiteDisassociateConversationRequest = {
// string | website id
website: website_example,
// string | This is the uuid of a conversation.
conversation: conversation_example,
};

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteDisassociatePerson

websiteDisassociatePerson()

This will enable us to dissassociate a website from a person.

Example

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

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

const body: Pieces.WebsiteDisassociatePersonRequest = {
// string | website id
website: website_example,
// string | This is a uuid that represents a person.
person: person_example,
};

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteDisassociateWorkstreamSummary

websiteDisassociateWorkstreamSummary()

This will enable us to disassociate a website 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.WebsiteApi(configuration)

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

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

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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-

websiteScoresIncrement

websiteScoresIncrement()

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

const body: Pieces.WebsiteScoresIncrementRequest = {
// string | website id
website: website_example,
// SeededScoreIncrement (optional)
seededScoreIncrement: ,
};

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

Parameters

NameTypeDescriptionNotes
seededScoreIncrementSeededScoreIncrement
website[string]website iddefaults 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-

websiteUpdate

Website websiteUpdate()

This will update a specific website.

Example

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

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

const body: Pieces.WebsiteUpdateRequest = {
// 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,
// Website (optional)
website: ,
};

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

Parameters

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

Website

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

websitesSpecificWebsiteSnapshot

Website websitesSpecificWebsiteSnapshot()

This will get a snapshot of a single website.

Example

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

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

const body: Pieces.WebsitesSpecificWebsiteSnapshotRequest = {
// string | website id
website: website_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.websitesSpecificWebsiteSnapshot(body).then((data: Website) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
website[string]website iddefaults 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

Website

HTTP request headers

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

HTTP response details

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