Interface: IRecipe

An interface representing an Entity object.

Interface

IEntity

Hierarchy

• IEntity

  ↳ IRecipe

Implemented by

• APIRecipeV2

Table of contents

Properties

• id
• clientId
• title
• creator
• projectIds
• description
• taskIds
• ontology
• labelScript
• toolsSettings
• uiSettings
• metadata
• createdAt
• updatedAt
• updatedBy
• v2

Properties

id

• id: string

A globally unique identifier for the Entity.

Inherited from

IEntity.id

clientId

• Optional clientId: string

A local identifier for the Entity, unique within the client.

Inherited from

IEntity.clientId

title

• title: string

creator

• creator: string

The creator of the Entity.

Overrides

IEntity.creator

projectIds

• projectIds: string[]

description

• description: string

taskIds

• taskIds: string[]

ontology

• ontology: IRecipeOntology

labelScript

• labelScript: string

toolsSettings

• toolsSettings: Dictionary

uiSettings

• uiSettings: Dictionary

metadata

• metadata: IRecipeMetaData

createdAt

• Optional createdAt: IDate

The date and time when the Entity was created.

Overrides

IEntity.createdAt

updatedAt

• Optional updatedAt: IDate

The date and time when the Entity was last updated.

Overrides

IEntity.updatedAt

updatedBy

• Optional updatedBy: string

The user who last updated the Entity.

Overrides

IEntity.updatedBy

v2

• Optional v2: boolean