Skip to main content

GetMetadataStructureItemIdByAlias

Gets metadata structure item ID by alias.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results =
await shellUI.Vault.VaultOperations.GetMetadataStructureItemIdByAlias({
item_type: 10000 /* Enum: MetadataStructureItem */,
alias: "<!< Alias to look for (without any ';').>",
});

Message

NameDescriptionType
item_typeMetadata structure item type.MetadataStructureItem
aliasAlias to look for (without any ';').string

Return type

NameDescriptionType
idReceives the ID, or -1 if a match is not found or if more than one item uses the specified alias. For named ACLs, -1000 is returned if a match is not found or if more than one item uses the specified alias.number

Example

{
"id": 0
}