Edit

Share via

ItemV2 interface

  • Reference
Package:
@ms-fabric/workload-client

An interface representing Fabric item metadata

Extends

Omit<Item, "itemType">

Properties

itemType

The type of the item

Inherited Properties

capacityObjectId

The object id of the capacity to which the item belongs
createdByUser

The item creator
createdByUserId

The numeric id of the item creator
createdDate

The creation date of the item
dataflowRelations

Relations with dataflows
datamartRelations

Relations with datamarts
datasetRelations

Relations with datasets
description

The description of the item
displayName

The display name of the item
dlpPolicyTip

The marker if the item has a DLP Policy Tips
extendedProperties

The extended properties of the item
folderObjectId

The object id of the folder to which the item belongs
itemPermissions

The customized permissions the user has on the current item
itemRelations

Relations with other Fabric items
lastUpdatedDate

The last update date of the item
modifiedByUser

The item modifier
modifiedByUserId

The numeric id of the item modifier
objectId

The object id of the item
ownerUser

The item owner
ownerUserId

The numeric id of the item owner
parentItemObjectId

The object id of the parent item of the current item
payloadContentType

The content type of the workload payload
permissions

The core permissions the user has on the current item
provisionState

The provision state of the item
subfolderId

The id of the subfolder to which the item belongs
systemItemType

The system item type marker
workloadPayload

The workload payload of the item

Property Details

itemType

The type of the item

itemType: string

Property Value

string

Inherited Property Details

capacityObjectId

The object id of the capacity to which the item belongs

capacityObjectId: string

Property Value

string

Inherited From Omit.capacityObjectId

createdByUser

The item creator

createdByUser?: User

Property Value

User

Inherited From Omit.createdByUser

createdByUserId

The numeric id of the item creator

createdByUserId?: number

Property Value

number

Inherited From Omit.createdByUserId

createdDate

The creation date of the item

createdDate?: Date

Property Value

Date

Inherited From Omit.createdDate

dataflowRelations

Relations with dataflows

dataflowRelations?: ItemDatasetRelation[]

Property Value

ItemDatasetRelation[]

Inherited From Omit.dataflowRelations

datamartRelations

Relations with datamarts

datamartRelations?: ItemDatasetRelation[]

Property Value

ItemDatasetRelation[]

Inherited From Omit.datamartRelations

datasetRelations

Relations with datasets

datasetRelations?: ItemDatasetRelation[]

Property Value

ItemDatasetRelation[]

Inherited From Omit.datasetRelations

description

The description of the item

description: string

Property Value

string

Inherited From Omit.description

displayName

The display name of the item

displayName: string

Property Value

string

Inherited From Omit.displayName

dlpPolicyTip

The marker if the item has a DLP Policy Tips

dlpPolicyTip?: DlpPolicyTip

Property Value

DlpPolicyTip

Inherited From Omit.dlpPolicyTip

extendedProperties

The extended properties of the item

extendedProperties?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited From Omit.extendedProperties

folderObjectId

The object id of the folder to which the item belongs

folderObjectId: string

Property Value

string

Inherited From Omit.folderObjectId

itemPermissions

The customized permissions the user has on the current item

itemPermissions?: number

Property Value

number

Inherited From Omit.itemPermissions

itemRelations

Relations with other Fabric items

itemRelations?: ItemRelation[]

Property Value

ItemRelation[]

Inherited From Omit.itemRelations

lastUpdatedDate

The last update date of the item

lastUpdatedDate: Date

Property Value

Date

Inherited From Omit.lastUpdatedDate

modifiedByUser

The item modifier

modifiedByUser?: User

Property Value

User

Inherited From Omit.modifiedByUser

modifiedByUserId

The numeric id of the item modifier

modifiedByUserId?: number

Property Value

number

Inherited From Omit.modifiedByUserId

objectId

The object id of the item

objectId: string

Property Value

string

Inherited From Omit.objectId

ownerUser

The item owner

ownerUser?: User

Property Value

User

Inherited From Omit.ownerUser

ownerUserId

The numeric id of the item owner

ownerUserId?: number

Property Value

number

Inherited From Omit.ownerUserId

parentItemObjectId

The object id of the parent item of the current item

parentItemObjectId?: string

Property Value

string

Inherited From Omit.parentItemObjectId

payloadContentType

The content type of the workload payload

payloadContentType?: "InlineJson" | "InlinePlainText" | "InlineXml" | "InlineBase64"

Property Value

"InlineJson" | "InlinePlainText" | "InlineXml" | "InlineBase64"

Inherited From Omit.payloadContentType

permissions

The core permissions the user has on the current item

permissions?: number

Property Value

number

Inherited From Omit.permissions

provisionState

The provision state of the item

provisionState: "InProgress" | "Failed" | "Active" | "Deleting" | "DisabledByDeprovisioning" | "DeprovisioningFailed" | "DeletedByDeprovision"

Property Value

"InProgress" | "Failed" | "Active" | "Deleting" | "DisabledByDeprovisioning" | "DeprovisioningFailed" | "DeletedByDeprovision"

Inherited From Omit.provisionState

subfolderId

The id of the subfolder to which the item belongs

subfolderId?: number

Property Value

number

Inherited From Omit.subfolderId

systemItemType

The system item type marker

systemItemType?: string

Property Value

string

Inherited From Omit.systemItemType

workloadPayload

The workload payload of the item

workloadPayload?: string

Property Value

string

Inherited From Omit.workloadPayload