< Back
Get-ProvDyn365EntityMetadata
Post
NAME Get-ProvDyn365EntityMetadata
SYNOPSIS
Get entity metadata of an entity in Dynamics365/ProvanceITSM.
SYNTAX
Get-ProvDyn365EntityMetadata -AuthContext <object> [-APIVersion <string>] [-FilterSection <string>]
[-SelectSection <string>] [<CommonParameters>]
DESCRIPTION
This cmdlet reads the metdata by specifying a filter for entity logical names in a Dynamics365/ProvanceITSM
instance via the WEB API.
PARAMETERS
-AuthContext <object>
The Authentication context generated by Get-ProvAzureAuthContext
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SelectSection <string>
The output filter for the entities, defined by a field name array, i.e.
"LogicalName,SchemaName,PrimaryIdAttribute,LogicalCollectionName"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FilterSection <string>
The input filter for the selection. i.e "LogicalName eq 'incident'" i.e "SchemaName eq 'Incident'" Important:
The filter for this cmdlet allows only operators which return unique values. Dont use 'contains', instead use
'eq' !!!
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-APIVersion <string>
The Web-API Version used to query. Default is 'v9.0'".
Change only if you know what you are doing ....
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Collections.Hashtable
---------- EXAMPLE 1 ----------
Get the entity metadata of a contact
Get-ProvDyn365EntityMetadata -AuthContext $token -FilterSection "LogicalName eq 'account'" -SelectSection
'DisplayName,IsLogicalEntity,Description'
The -FilterSelection defines which entity????s metadata shall be retrieved.
!!! For this cmdlet, the filter allows operators which return unique values. Dont use 'contains', instead use
'eq' !!!
The -Selectsection parameter limits the number of returned metadata values and must be a string, so put it in
qotes.
Without this parameter, the cmdlet returns all metadata values.
The example above limits the output to DisplayName, IsLogicalEntity and Description.
The metadataid of the entity is always returned.
The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure
Module.
RELATED LINKS
Provance Technologies Inc. (http://provance.com)
Help (http://help.provance.com)
SYNOPSIS
Get entity metadata of an entity in Dynamics365/ProvanceITSM.
SYNTAX
Get-ProvDyn365EntityMetadata -AuthContext <object> [-APIVersion <string>] [-FilterSection <string>]
[-SelectSection <string>] [<CommonParameters>]
DESCRIPTION
This cmdlet reads the metdata by specifying a filter for entity logical names in a Dynamics365/ProvanceITSM
instance via the WEB API.
PARAMETERS
-AuthContext <object>
The Authentication context generated by Get-ProvAzureAuthContext
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SelectSection <string>
The output filter for the entities, defined by a field name array, i.e.
"LogicalName,SchemaName,PrimaryIdAttribute,LogicalCollectionName"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FilterSection <string>
The input filter for the selection. i.e "LogicalName eq 'incident'" i.e "SchemaName eq 'Incident'" Important:
The filter for this cmdlet allows only operators which return unique values. Dont use 'contains', instead use
'eq' !!!
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-APIVersion <string>
The Web-API Version used to query. Default is 'v9.0'".
Change only if you know what you are doing ....
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Collections.Hashtable
---------- EXAMPLE 1 ----------
Get the entity metadata of a contact
Get-ProvDyn365EntityMetadata -AuthContext $token -FilterSection "LogicalName eq 'account'" -SelectSection
'DisplayName,IsLogicalEntity,Description'
The -FilterSelection defines which entity????s metadata shall be retrieved.
!!! For this cmdlet, the filter allows operators which return unique values. Dont use 'contains', instead use
'eq' !!!
The -Selectsection parameter limits the number of returned metadata values and must be a string, so put it in
qotes.
Without this parameter, the cmdlet returns all metadata values.
The example above limits the output to DisplayName, IsLogicalEntity and Description.
The metadataid of the entity is always returned.
The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure
Module.
RELATED LINKS
Provance Technologies Inc. (http://provance.com)
Help (http://help.provance.com)