Class: APIRecipeV2
An interface representing an Entity object.
Interface
IEntity
Implements
Table of contents
Constructors
Properties
- description
- id
- createdAt
- updatedAt
- updatedBy
- labelScript
- creator
- metadata
- ontology
- projectIds
- taskIds
- title
- toolsSettings
- uiSettings
- v2
Accessors
Constructors
constructor
• new APIRecipeV2(recipe)
Parameters
| Name | Type |
|---|---|
recipe | Partial<APIRecipeV2> |
Properties
description
• description: string
Implementation of
id
• id: string
A globally unique identifier for the Entity.
Implementation of
createdAt
• Optional createdAt: Date
The date and time when the Entity was created.
Implementation of
updatedAt
• Optional updatedAt: Date
The date and time when the Entity was last updated.
Implementation of
updatedBy
• Optional updatedBy: string
The user who last updated the Entity.
Implementation of
labelScript
• labelScript: string
Implementation of
creator
• creator: string
The creator of the Entity.
Implementation of
metadata
• metadata: IRecipeMetaData
Implementation of
ontology
• ontology: IRecipeOntology
Implementation of
projectIds
• projectIds: string[]
Implementation of
taskIds
• taskIds: string[]
Implementation of
title
• title: string
Implementation of
toolsSettings
• toolsSettings: Dictionary
Implementation of
uiSettings
• uiSettings: Dictionary
Implementation of
v2
• v2: true
Implementation of
Accessors
ontologyId
• get ontologyId(): string
Returns
string
attributes
• get attributes(): string[]
Returns
string[]