topic Re: Method to get Custom Entity Properties thru API in Vault Customization Forum

Method to get Custom Entity Properties thru API

Eli_Dexter — Fri, 18 Aug 2023 16:42:42 GMT

How do I get Custom Object Properties in Powershell with PowerVault using API call.

I have looked thru SDK documentation and could not find in CustomEntityService any Methods that let me get the Properties of the Custom Object and their Values.

Interestingly, there is UpdateCustomEntity method to update Custom Objects. But before Update I would like to check if update is required.

Thanks

Re: Method to get Custom Entity Properties thru API

dave_taylor — Mon, 21 Aug 2023 13:00:12 GMT

If you are using coolOrange powerVault, you can get the file like this and then get the property needed:

# get the file

$file = Get-VaultFile -File '$/Designs/Part01.ipt'

# get the property needed
$propCustom = $file.'CustomPropName'

Check here: https://doc.coolorange.com/projects/powervault/en/stable/code_reference/commandlets/

Items are a similar method. Check the commandlet reference with the link above.

Re: Method to get Custom Entity Properties thru API

Eli_Dexter — Mon, 21 Aug 2023 15:03:08 GMT

The question was not about file properties but Custom Object properties. Unfortunately, CoolOrange practically does not support Custom Objects.

Re: Method to get Custom Entity Properties thru API

Markus.Koechl — Mon, 21 Aug 2023 15:07:16 GMT

You can retrieve properties of custom objects as shown here:

#retrieve property value given by displayname from Custom Object (ID) function mGetCustentPropValue ([Int64] $mCentID, [STRING] $mDispName) { $PropDefs = $vault.PropertyService.GetPropertyDefinitionsByEntityClassId("CUSTENT") $propDefIds = @() $PropDefs | ForEach-Object { $propDefIds += $_.Id } $mPropDef = $propDefs | Where-Object { $_.DispName -eq $mDispName} $mEntIDs = @() $mEntIDs += $mCentID $mPropDefIDs = @() $mPropDefIDs += $mPropDef.Id $mProp = $vault.PropertyService.GetProperties("CUSTENT",$mEntIDs, $mPropDefIDs) $mProp | Where-Object { $mPropVal = $_.Val } Return $mPropVal }

Re: Method to get Custom Entity Properties thru API

Eli_Dexter — Mon, 21 Aug 2023 16:17:32 GMT

Thanks

Re: Method to get Custom Entity Properties thru API

J_Dumont — Thu, 13 Feb 2025 01:35:19 GMT

Hi Markus,

I am trying to use the code in your example but getting errors. Any help would be greatly appreciated.

The code needs to retrieve a UDP from the custom object called "RTE_Creator." In this case, it's an email that I will use to send an email.

Here's my function:

elseif ($customObject._NewState -eq "Approved" -and $customObject._State -eq "Review"){ $subject = "An RTE State was Changed: " $body = "An RTE was just Approved: " + $RTENumber $RTECreatorEmail=mGetCustentPropValue($customObject, "RTE_Creator")

Here's the error

Re: Method to get Custom Entity Properties thru API

Markus.Koechl — Thu, 13 Feb 2025 06:41:38 GMT

@J_Dumont, you need to hand over the custom objects Id, not the custom object.

$RTECreatorEmail=mGetCustentPropValue($customObject.Id, "RTE_Creator")

Re: Method to get Custom Entity Properties thru API

J_Dumont — Thu, 13 Feb 2025 12:05:29 GMT

Hi Markus,

My apologies. That's what I tried first, and I got the same error.

I am able to show I have a value for $CustomObject.Id as shown below.

Re: Method to get Custom Entity Properties thru API

Markus.Koechl — Thu, 13 Feb 2025 13:25:02 GMT

I wonder how the error could be the same if $mCentID is the custom entity (object) or the ID (int64).

Re: Method to get Custom Entity Properties thru API

dave_taylor — Thu, 13 Feb 2025 15:27:57 GMT

If you are using powerShell, send the variables to the function like this:

$RTECreatorEmail = mGetCustentPropValue $customObject.Id "RTE_Creator"

Don't use the parenthesis when calling the function with variables. I tried this and it works as it should for you...

Re: Method to get Custom Entity Properties thru API

J_Dumont — Thu, 13 Feb 2025 16:20:49 GMT

Hi Dave,

Yes, your solution worked great.!!

Thank you both for replying so quickly.