Skip to main content

FlattenedPerson

if expiration is add then, after the alloted expiration date the user will only have view && comment only permissions. Only present in the case there is a scope such as a defined collection/asset... if asset is passed then that means this person belongs to a scoped asset.

Properties

NameType
schemaEmbeddedModelSchema
idstring
createdGroupedTimestamp
updatedGroupedTimestamp
deletedGroupedTimestamp
typePersonType
assetsFlattenedAssets
mechanisms{ [key: string]: MechanismEnum; }
interactionsnumber
access{ [key: string]: PersonAccess; }
tagsFlattenedTags
websitesFlattenedWebsites
models{ [key: string]: PersonModel; }
annotationsFlattenedAnnotations
scoreScore
summariesFlattenedWorkstreamSummaries

Example

import { FlattenedPerson } from '@pieces.app/pieces-os-client'

// TODO: Update the object below with actual values
const example: FlattenedPerson = {
"schema": null,
"id": null,
"created": null,
"updated": null,
"deleted": null,
"type": null,
"assets": null,
"mechanisms": null,
"interactions": null,
"access": null,
"tags": null,
"websites": null,
"models": null,
"annotations": null,
"score": null,
"summaries": null,
}

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as FlattenedPerson
console.log(exampleParsed)