< Back
Update-ProvDyn365Entity
Post
NAME Update-ProvDyn365Entity
SYNOPSIS
Update an entity from a Dynamics365/Provance ITSM instance via the Web-API.
SYNTAX
Update-ProvDyn365Entity -AuthContext <object> -Body <object> -EntityName <string> -Id <Guid> [-APIVersion
<string>] [-IncludeFormattedValue <SwitchParameter>] [-SelectSection <string>] [<CommonParameters>]
Update-ProvDyn365Entity -AlternateKey <string> -AuthContext <object> -Body <object> -EntityName <string>
[-APIVersion <string>] [-IncludeFormattedValue <SwitchParameter>] [-SelectSection <string>] [<CommonParameters>]
DESCRIPTION
This cmdlet connects to a Dynamics365/ProvanceITSM instance and sets new values on an entitiy.
It supports 2 Parametersets.
2.) "Entity by ID"
3.) "Entity by Alternate Key"
PARAMETERS
-AuthContext <object>
The Authentication context generated by Get-ProvAzureAuthContext
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntityName <string>
The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Id <Guid>
The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.
Required? true
Position? named
Default value 00000000-0000-0000-0000-000000000000
Accept pipeline input? false
Accept wildcard characters? false
-AlternateKey <string>
The Alternate Key of the entity in Dynamics365/ProvanceITSM.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Body <object>
A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate
those.
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. "name,address1". (PS: the id of the
entity will always be returned) When you select more than one value put the values inside quotes and seperate
them by commas.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeFormattedValue <SwitchParameter>
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-APIVersion <string>
The Web-API Version used to query. Default is 'v9.0'".
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 ----------
Set an entity with the logical name "apitil_configurationitem" with a new description
Update-ProvDyn365Entity -AuthContext $token -EntityName 'apitil_configurationitem' -id
'81df8c29-d4b6-4c3f-8f7b-0e6bbabd0d78' -body $ciBody
Parameterset used is "Update by id", and we look for the entity with the logical name "apitil_configurationitem"
The $cibody variable is a hashtable, containing the key/value pair of the field which shall be udpated.
Example of $cibody:
$cibody = @{
"apitil_description"= "Laptop Lenovo T440s with SerialNumber ABC0815"
}
The -id is the GUID in Dynamics365/ProvanceITSM.
When you test this, the cmdlet will also output the id, which is a default setting and cannot be changed.
The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure
Module.
---------- EXAMPLE 2 ----------
Update an entity found by an alternate key.
Update-ProvDyn365Entity -AuthContext $token -Entity 'apitil_configurationitem' -alternateKey
'2a01fcb8-d877-42fd-b700-b3da13d8f472' -body $cibody
Parameterset used is "Update by Alternate Key", and we look for an entity of type "apitil_configurationitem"
where the alternate key of the entity has the value of the above example.
The $cibody variable is a hashtable, containing the key/value pair of the field which shall be udpated.
Example of $cibody:
$cibody = @{
"apitil_description"= "Laptop Lenovo T440s with SerialNumber ABC0815"
}
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
Update an entity from a Dynamics365/Provance ITSM instance via the Web-API.
SYNTAX
Update-ProvDyn365Entity -AuthContext <object> -Body <object> -EntityName <string> -Id <Guid> [-APIVersion
<string>] [-IncludeFormattedValue <SwitchParameter>] [-SelectSection <string>] [<CommonParameters>]
Update-ProvDyn365Entity -AlternateKey <string> -AuthContext <object> -Body <object> -EntityName <string>
[-APIVersion <string>] [-IncludeFormattedValue <SwitchParameter>] [-SelectSection <string>] [<CommonParameters>]
DESCRIPTION
This cmdlet connects to a Dynamics365/ProvanceITSM instance and sets new values on an entitiy.
It supports 2 Parametersets.
2.) "Entity by ID"
3.) "Entity by Alternate Key"
PARAMETERS
-AuthContext <object>
The Authentication context generated by Get-ProvAzureAuthContext
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntityName <string>
The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Id <Guid>
The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.
Required? true
Position? named
Default value 00000000-0000-0000-0000-000000000000
Accept pipeline input? false
Accept wildcard characters? false
-AlternateKey <string>
The Alternate Key of the entity in Dynamics365/ProvanceITSM.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Body <object>
A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate
those.
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. "name,address1". (PS: the id of the
entity will always be returned) When you select more than one value put the values inside quotes and seperate
them by commas.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeFormattedValue <SwitchParameter>
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-APIVersion <string>
The Web-API Version used to query. Default is 'v9.0'".
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 ----------
Set an entity with the logical name "apitil_configurationitem" with a new description
Update-ProvDyn365Entity -AuthContext $token -EntityName 'apitil_configurationitem' -id
'81df8c29-d4b6-4c3f-8f7b-0e6bbabd0d78' -body $ciBody
Parameterset used is "Update by id", and we look for the entity with the logical name "apitil_configurationitem"
The $cibody variable is a hashtable, containing the key/value pair of the field which shall be udpated.
Example of $cibody:
$cibody = @{
"apitil_description"= "Laptop Lenovo T440s with SerialNumber ABC0815"
}
The -id is the GUID in Dynamics365/ProvanceITSM.
When you test this, the cmdlet will also output the id, which is a default setting and cannot be changed.
The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure
Module.
---------- EXAMPLE 2 ----------
Update an entity found by an alternate key.
Update-ProvDyn365Entity -AuthContext $token -Entity 'apitil_configurationitem' -alternateKey
'2a01fcb8-d877-42fd-b700-b3da13d8f472' -body $cibody
Parameterset used is "Update by Alternate Key", and we look for an entity of type "apitil_configurationitem"
where the alternate key of the entity has the value of the above example.
The $cibody variable is a hashtable, containing the key/value pair of the field which shall be udpated.
Example of $cibody:
$cibody = @{
"apitil_description"= "Laptop Lenovo T440s with SerialNumber ABC0815"
}
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)