Skip to main content

Person API

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

MethodHTTP requestDescription
personAssociateWorkstreamSummaryPOST /person/{person}/workstream_summaries/associate/{workstream_summary}/person/{person}/workstream_summaries/associate/{workstream_summary} [POST]
personDisassociateWorkstreamSummaryPOST /person/{person}/workstream_summaries/disassociate/{workstream_summary}/person/{person}/workstream_summaries/disassociate/{workstream_summary} [POST]
personScoresIncrementPOST /person/{person}/scores/increment'/person/{person}/scores/increment' [POST]
personSnapshotGET /person/{person}/person/{person} [GET]
updatePersonPOST /person/update/person/update [POST]

personAssociateWorkstreamSummary

personAssociateWorkstreamSummary()

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

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

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

Parameters

NameTypeDescriptionNotes
person[string]This is a uuid that represents a person.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-

personDisassociateWorkstreamSummary

personDisassociateWorkstreamSummary()

This will enable us to disassociate an person 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.PersonApi(configuration)

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

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

Parameters

NameTypeDescriptionNotes
person[string]This is a uuid that represents a person.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-

personScoresIncrement

personScoresIncrement()

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

const body: Pieces.PersonScoresIncrementRequest = {
// string | This is a uuid that represents a person.
person: person_example,
// SeededScoreIncrement (optional)
seededScoreIncrement: ,
};

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

Parameters

NameTypeDescriptionNotes
seededScoreIncrementSeededScoreIncrement
person[string]This is a uuid that represents a person.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-

personSnapshot

Person personSnapshot()

This will get a snapshot of a specific person

Example

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

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

const body: Pieces.PersonSnapshotRequest = {
// string | This is a uuid that represents a person.
person: person_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.personSnapshot(body).then((data: Person) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
person[string]This is a uuid that represents a person.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

Person

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

updatePerson

Person updatePerson()

This will update a specific person

Example

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

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

const body: Pieces.UpdatePersonRequest = {
// 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,
// Person (optional)
person: ,
};

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

Parameters

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

Person

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-